├── .gemfiles ├── rails3_2.gemfile ├── rails4_0.gemfile ├── rails4_1.gemfile ├── rails4_2.gemfile └── rails5_0.gemfile ├── .gitignore ├── .travis.yml ├── Gemfile ├── LICENSE ├── MIT-LICENSE ├── README.md ├── README.rdoc ├── Rakefile ├── lib ├── mailgun_rails.rb └── mailgun_rails │ ├── attachment.rb │ ├── client.rb │ ├── deliverer.rb │ ├── mail_ext.rb │ └── version.rb ├── mailgun_rails.gemspec └── spec ├── dummy ├── .gitignore ├── README.rdoc ├── Rakefile ├── app │ ├── assets │ │ ├── images │ │ │ └── rails.png │ │ ├── javascripts │ │ │ └── application.js │ │ └── stylesheets │ │ │ └── application.css │ ├── controllers │ │ └── application_controller.rb │ ├── helpers │ │ └── application_helper.rb │ ├── mailers │ │ ├── .gitkeep │ │ └── sandbox_mailer.rb │ ├── models │ │ └── .gitkeep │ └── views │ │ ├── layouts │ │ └── application.html.erb │ │ └── sandbox_mailer │ │ └── sandbox.html.erb ├── config.ru ├── config │ ├── application.rb │ ├── boot.rb │ ├── database.yml │ ├── environment.rb │ ├── environments │ │ ├── development.rb │ │ ├── production.rb │ │ └── test.rb │ ├── initializers │ │ ├── backtrace_silencers.rb │ │ ├── inflections.rb │ │ ├── mime_types.rb │ │ ├── secret_token.rb │ │ ├── session_store.rb │ │ └── wrap_parameters.rb │ ├── locales │ │ └── en.yml │ └── routes.rb ├── db │ └── seeds.rb ├── doc │ └── README_FOR_APP ├── lib │ ├── assets │ │ └── .gitkeep │ └── tasks │ │ └── .gitkeep ├── log │ └── .gitkeep ├── public │ ├── 404.html │ ├── 422.html │ ├── 500.html │ ├── favicon.ico │ ├── index.html │ └── robots.txt ├── script │ └── rails ├── test │ ├── fixtures │ │ └── .gitkeep │ ├── functional │ │ └── .gitkeep │ ├── integration │ │ └── .gitkeep │ ├── performance │ │ └── browsing_test.rb │ ├── test_helper.rb │ └── unit │ │ └── .gitkeep └── vendor │ ├── assets │ ├── javascripts │ │ └── .gitkeep │ └── stylesheets │ │ └── .gitkeep │ └── plugins │ └── .gitkeep ├── lib └── mailgun_rails │ ├── attachment_spec.rb │ ├── client_spec.rb │ └── deliverer_spec.rb └── spec_helper.rb /.gemfiles/rails3_2.gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gem 'rails', '~> 3.2.0' 4 | 5 | gemspec path: '../' 6 | 7 | gem 'sqlite3', platform: :ruby 8 | gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby 9 | -------------------------------------------------------------------------------- /.gemfiles/rails4_0.gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gem 'rails', '~> 4.0.0' 4 | 5 | gemspec path: '../' 6 | 7 | gem 'sqlite3', platform: :ruby 8 | gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby 9 | -------------------------------------------------------------------------------- /.gemfiles/rails4_1.gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gem 'rails', '~> 4.1.0' 4 | 5 | gemspec path: '../' 6 | 7 | gem 'sqlite3', platform: :ruby 8 | gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby 9 | -------------------------------------------------------------------------------- /.gemfiles/rails4_2.gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gem 'rails', '~> 4.2.0' 4 | 5 | gemspec path: '../' 6 | 7 | gem 'sqlite3', platform: :ruby 8 | gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby 9 | -------------------------------------------------------------------------------- /.gemfiles/rails5_0.gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gem 'rails', '~> 5.0.0' 4 | 5 | gemspec path: '../' 6 | 7 | gem 'sqlite3', platform: :ruby 8 | gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.rbc 2 | *.sassc 3 | .sass-cache 4 | capybara-*.html 5 | .rspec 6 | /.bundle 7 | /vendor/bundle 8 | /log/* 9 | /tmp/* 10 | /db/*.sqlite3 11 | /public/system/* 12 | /coverage/ 13 | /spec/tmp/* 14 | **.orig 15 | rerun.txt 16 | pickle-email-*.html 17 | /pkg/ 18 | Gemfile.lock -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | sudo: false 3 | cache: bundler 4 | rvm: 5 | - 2.2.2 6 | - 2.2.3 7 | - 2.2.4 8 | - 2.2.5 9 | - 2.3.0 10 | - 2.3.1 11 | # - jruby-1.7.20 12 | # - jruby-9.0.0.0 13 | - rbx 14 | matrix: 15 | include: 16 | - rvm: 2.2.5 17 | gemfile: .gemfiles/rails3_2.gemfile 18 | - rvm: 2.3.1 19 | gemfile: .gemfiles/rails4_0.gemfile 20 | - rvm: 2.3.1 21 | gemfile: .gemfiles/rails4_1.gemfile 22 | - rvm: 2.3.1 23 | gemfile: .gemfiles/rails4_2.gemfile 24 | - rvm: 2.3.1 25 | gemfile: .gemfiles/rails5_0.gemfile 26 | allow_failures: 27 | - rvm: rbx 28 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Declare your gem's dependencies in mailgun_rails.gemspec. 4 | # Bundler will treat runtime dependencies like base dependencies, and 5 | # development dependencies will be added by default to the :development group. 6 | gemspec 7 | 8 | gem 'sqlite3', platform: :ruby 9 | gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2013 Jorge Manrubia 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | this software and associated documentation files (the "Software"), to deal in 7 | the Software without restriction, including without limitation the rights to 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software is furnished to do so, 10 | subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /MIT-LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2013 Jorge Manrubia 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining 4 | a copy of this software and associated documentation files (the 5 | "Software"), to deal in the Software without restriction, including 6 | without limitation the rights to use, copy, modify, merge, publish, 7 | distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to 9 | the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be 12 | included in all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mailgun_rails 2 | 3 | [![Build Status](https://travis-ci.org/jorgemanrubia/mailgun_rails.svg?branch=master)](https://travis-ci.org/jorgemanrubia/mailgun_rails) 4 | 5 | *mailgun_rails* is an Action Mailer adapter for using [Mailgun](http://www.mailgun.com/) in Rails apps. It uses the [Mailgun HTTP API](http://documentation.mailgun.com/api_reference.html) internally. 6 | 7 | ## Installing 8 | 9 | In your `Gemfile` 10 | 11 | ```ruby 12 | gem 'mailgun_rails' 13 | ``` 14 | 15 | ## Usage 16 | 17 | To configure your Mailgun credentials place the following code in the corresponding environment file (`development.rb`, `production.rb`...) 18 | 19 | ```ruby 20 | config.action_mailer.delivery_method = :mailgun 21 | config.action_mailer.mailgun_settings = { 22 | api_key: '', 23 | domain: '' 24 | } 25 | ``` 26 | 27 | Now you can send emails using plain Action Mailer: 28 | 29 | ```ruby 30 | email = mail from: 'sender@email.com', to: 'receiver@email.com', subject: 'this is an email' 31 | or 32 | email = mail from: 'Your Name Here ', to: 'receiver@email.com', subject: 'this is an email' 33 | ``` 34 | 35 | ### [Mailgun variables](http://documentation.mailgun.com/user_manual.html#attaching-data-to-messages) 36 | 37 | ```ruby 38 | email.mailgun_variables = {name_1: :value_1, name_2: value_2} 39 | ``` 40 | 41 | ### [Recipient Variables (for batch sending)](http://documentation.mailgun.com/user_manual.html#batch-sending) 42 | 43 | ```ruby 44 | email.mailgun_recipient_variables = {'user_1@email.com' => {id: 1}, 'user_2@email.com' => {id: 2}} 45 | ``` 46 | 47 | ### [Custom MIME headers](http://documentation.mailgun.com/api-sending.html#sending) 48 | 49 | ```ruby 50 | email.mailgun_headers = {foo: 'bar'} 51 | ``` 52 | 53 | ### Mailgun options 54 | 55 | To provide option parameters like `o:campaign` or `o:tag`. 56 | 57 | ```ruby 58 | email.mailgun_options = {campaign: '1'} 59 | ``` 60 | 61 | Pull requests are welcomed 62 | 63 | 64 | -------------------------------------------------------------------------------- /README.rdoc: -------------------------------------------------------------------------------- 1 | = MailgunRails 2 | 3 | This project rocks and uses MIT-LICENSE. -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | begin 2 | require 'bundler/setup' 3 | rescue LoadError 4 | puts 'You must `gem install bundler` and `bundle install` to run rake tasks' 5 | end 6 | 7 | require 'rdoc/task' 8 | 9 | RDoc::Task.new(:rdoc) do |rdoc| 10 | rdoc.rdoc_dir = 'rdoc' 11 | rdoc.title = 'MailgunRails' 12 | rdoc.options << '--line-numbers' 13 | rdoc.rdoc_files.include('README.rdoc') 14 | rdoc.rdoc_files.include('lib/**/*.rb') 15 | end 16 | 17 | Bundler::GemHelper.install_tasks 18 | 19 | require 'rspec/core/rake_task' 20 | 21 | RSpec::Core::RakeTask.new(:spec) 22 | 23 | task default: :spec 24 | -------------------------------------------------------------------------------- /lib/mailgun_rails.rb: -------------------------------------------------------------------------------- 1 | require 'action_mailer' 2 | require 'json' 3 | 4 | 5 | Dir[File.dirname(__FILE__) + '/mailgun_rails/*.rb'].each {|file| require file } 6 | 7 | module MailgunRails 8 | end 9 | -------------------------------------------------------------------------------- /lib/mailgun_rails/attachment.rb: -------------------------------------------------------------------------------- 1 | module MailgunRails 2 | class Attachment < StringIO 3 | attr_reader :original_filename, :content_type, :path 4 | 5 | def initialize (attachment, *rest) 6 | @path = '' 7 | if rest.detect {|opt| opt[:inline] } 8 | basename = @original_filename = attachment.cid 9 | else 10 | basename = @original_filename = attachment.filename 11 | end 12 | @content_type = attachment.content_type.split(';')[0] 13 | super attachment.body.decoded 14 | end 15 | end 16 | end 17 | -------------------------------------------------------------------------------- /lib/mailgun_rails/client.rb: -------------------------------------------------------------------------------- 1 | require 'rest_client' 2 | 3 | 4 | module MailgunRails 5 | class Client 6 | attr_reader :api_key, :domain, :verify_ssl 7 | 8 | def initialize(api_key, domain, verify_ssl = true) 9 | @api_key = api_key 10 | @domain = domain 11 | @verify_ssl = verify_ssl 12 | end 13 | 14 | def send_message(options) 15 | RestClient::Request.execute( 16 | method: :post, 17 | url: mailgun_url, 18 | payload: options, 19 | verify_ssl: verify_ssl 20 | ) 21 | end 22 | 23 | def mailgun_url 24 | api_url+"/messages" 25 | end 26 | 27 | def api_url 28 | "https://api:#{api_key}@api.mailgun.net/v3/#{domain}" 29 | end 30 | end 31 | end 32 | -------------------------------------------------------------------------------- /lib/mailgun_rails/deliverer.rb: -------------------------------------------------------------------------------- 1 | module MailgunRails 2 | class Deliverer 3 | 4 | attr_accessor :settings 5 | 6 | def initialize(settings) 7 | self.settings = settings 8 | end 9 | 10 | def domain 11 | self.settings[:domain] 12 | end 13 | 14 | def api_key 15 | self.settings[:api_key] 16 | end 17 | 18 | def verify_ssl 19 | #default value = true 20 | self.settings[:verify_ssl] != false 21 | end 22 | 23 | def deliver!(rails_message) 24 | response = mailgun_client.send_message build_mailgun_message_for(rails_message) 25 | if response.code == 200 26 | mailgun_message_id = JSON.parse(response.to_str)["id"] 27 | rails_message.message_id = mailgun_message_id 28 | end 29 | response 30 | end 31 | 32 | private 33 | 34 | def build_mailgun_message_for(rails_message) 35 | mailgun_message = build_basic_mailgun_message_for rails_message 36 | transform_mailgun_attributes_from_rails rails_message, mailgun_message 37 | remove_empty_values mailgun_message 38 | 39 | mailgun_message 40 | end 41 | 42 | def transform_mailgun_attributes_from_rails(rails_message, mailgun_message) 43 | transform_reply_to rails_message, mailgun_message if rails_message.reply_to 44 | transform_mailgun_variables rails_message, mailgun_message 45 | transform_mailgun_options rails_message, mailgun_message 46 | transform_mailgun_recipient_variables rails_message, mailgun_message 47 | transform_custom_headers rails_message, mailgun_message 48 | end 49 | 50 | def build_basic_mailgun_message_for(rails_message) 51 | mailgun_message = { 52 | from: rails_message[:from].formatted, 53 | to: rails_message[:to].formatted, 54 | subject: rails_message.subject, 55 | html: extract_html(rails_message), 56 | text: extract_text(rails_message) 57 | } 58 | 59 | [:cc, :bcc].each do |key| 60 | mailgun_message[key] = rails_message[key].formatted if rails_message[key] 61 | end 62 | 63 | return mailgun_message if rails_message.attachments.empty? 64 | 65 | # RestClient requires attachments to be in file format, use a temp directory and the decoded attachment 66 | mailgun_message[:attachment] = [] 67 | mailgun_message[:inline] = [] 68 | rails_message.attachments.each do |attachment| 69 | # then add as a file object 70 | if attachment.inline? 71 | mailgun_message[:inline] << MailgunRails::Attachment.new(attachment, encoding: 'ascii-8bit', inline: true) 72 | else 73 | mailgun_message[:attachment] << MailgunRails::Attachment.new(attachment, encoding: 'ascii-8bit') 74 | end 75 | end 76 | 77 | return mailgun_message 78 | end 79 | 80 | def transform_reply_to(rails_message, mailgun_message) 81 | mailgun_message['h:Reply-To'] = rails_message[:reply_to].formatted.first 82 | end 83 | 84 | # @see http://stackoverflow.com/questions/4868205/rails-mail-getting-the-body-as-plain-text 85 | def extract_html(rails_message) 86 | if rails_message.html_part 87 | rails_message.html_part.body.decoded 88 | else 89 | rails_message.content_type =~ /text\/html/ ? rails_message.body.decoded : nil 90 | end 91 | end 92 | 93 | def extract_text(rails_message) 94 | if rails_message.multipart? 95 | rails_message.text_part ? rails_message.text_part.body.decoded : nil 96 | else 97 | rails_message.content_type =~ /text\/plain/ ? rails_message.body.decoded : nil 98 | end 99 | end 100 | 101 | def transform_mailgun_variables(rails_message, mailgun_message) 102 | rails_message.mailgun_variables.try(:each) do |name, value| 103 | mailgun_message["v:#{name}"] = value 104 | end 105 | end 106 | 107 | def transform_mailgun_options(rails_message, mailgun_message) 108 | rails_message.mailgun_options.try(:each) do |name, value| 109 | mailgun_message["o:#{name}"] = value 110 | end 111 | end 112 | 113 | def transform_custom_headers(rails_message, mailgun_message) 114 | rails_message.mailgun_headers.try(:each) do |name, value| 115 | mailgun_message["h:#{name}"] = value 116 | end 117 | end 118 | 119 | def transform_mailgun_recipient_variables(rails_message, mailgun_message) 120 | mailgun_message['recipient-variables'] = rails_message.mailgun_recipient_variables.to_json if rails_message.mailgun_recipient_variables 121 | end 122 | 123 | def remove_empty_values(mailgun_message) 124 | mailgun_message.delete_if { |key, value| value.nil? or 125 | value.respond_to?(:empty?) && value.empty? } 126 | end 127 | 128 | def mailgun_client 129 | @maingun_client ||= Client.new(api_key, domain, verify_ssl) 130 | end 131 | end 132 | end 133 | 134 | ActionMailer::Base.add_delivery_method :mailgun, MailgunRails::Deliverer 135 | -------------------------------------------------------------------------------- /lib/mailgun_rails/mail_ext.rb: -------------------------------------------------------------------------------- 1 | module Mail 2 | class Message 3 | attr_accessor :mailgun_variables 4 | attr_accessor :mailgun_options 5 | attr_accessor :mailgun_recipient_variables 6 | attr_accessor :mailgun_headers 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /lib/mailgun_rails/version.rb: -------------------------------------------------------------------------------- 1 | module MailgunRails 2 | VERSION = "0.9.0" 3 | end 4 | -------------------------------------------------------------------------------- /mailgun_rails.gemspec: -------------------------------------------------------------------------------- 1 | $:.push File.expand_path("../lib", __FILE__) 2 | 3 | # Maintain your gem's version: 4 | require "mailgun_rails/version" 5 | 6 | # Describe your gem and declare its dependencies: 7 | Gem::Specification.new do |s| 8 | s.name = "mailgun_rails" 9 | s.version = MailgunRails::VERSION 10 | s.authors = ["Jorge Manrubia"] 11 | s.email = ["jorge.manrubia@gmail.com"] 12 | s.homepage = "https://github.com/jorgemanrubia/mailgun_rails/" 13 | s.summary = "Rails Action Mailer adapter for Mailgun" 14 | s.description = "An adapter for using Mailgun with Rails and Action Mailer" 15 | s.license = 'MIT' 16 | 17 | s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"] 18 | s.test_files = Dir["test/**/*"] 19 | 20 | s.add_dependency "actionmailer", ">= 3.2.13" 21 | s.add_dependency "json", ">= 1.7.7" 22 | s.add_dependency "rest-client", ">= 1.6.7" 23 | 24 | s.add_development_dependency "rspec", '~> 2.14.1' 25 | s.add_development_dependency "rails", ">= 3.2.13" 26 | end 27 | -------------------------------------------------------------------------------- /spec/dummy/.gitignore: -------------------------------------------------------------------------------- 1 | # See http://help.github.com/ignore-files/ for more about ignoring files. 2 | # 3 | # If you find yourself ignoring temporary files generated by your text editor 4 | # or operating system, you probably want to add a global ignore instead: 5 | # git config --global core.excludesfile ~/.gitignore_global 6 | 7 | # Ignore bundler config 8 | /.bundle 9 | 10 | # Ignore the default SQLite database. 11 | /db/*.sqlite3 12 | 13 | # Ignore all logfiles and tempfiles. 14 | /log/*.log 15 | /tmp 16 | -------------------------------------------------------------------------------- /spec/dummy/README.rdoc: -------------------------------------------------------------------------------- 1 | == Welcome to Rails 2 | 3 | Rails is a web-application framework that includes everything needed to create 4 | database-backed web applications according to the Model-View-Control pattern. 5 | 6 | This pattern splits the view (also called the presentation) into "dumb" 7 | templates that are primarily responsible for inserting pre-built data in between 8 | HTML tags. The model contains the "smart" domain objects (such as Account, 9 | Product, Person, Post) that holds all the business logic and knows how to 10 | persist themselves to a database. The controller handles the incoming requests 11 | (such as Save New Account, Update Product, Show Post) by manipulating the model 12 | and directing data to the view. 13 | 14 | In Rails, the model is handled by what's called an object-relational mapping 15 | layer entitled Active Record. This layer allows you to present the data from 16 | database rows as objects and embellish these data objects with business logic 17 | methods. You can read more about Active Record in 18 | link:files/vendor/rails/activerecord/README.html. 19 | 20 | The controller and view are handled by the Action Pack, which handles both 21 | layers by its two parts: Action View and Action Controller. These two layers 22 | are bundled in a single package due to their heavy interdependence. This is 23 | unlike the relationship between the Active Record and Action Pack that is much 24 | more separate. Each of these packages can be used independently outside of 25 | Rails. You can read more about Action Pack in 26 | link:files/vendor/rails/actionpack/README.html. 27 | 28 | 29 | == Getting Started 30 | 31 | 1. At the command prompt, create a new Rails application: 32 | rails new myapp (where myapp is the application name) 33 | 34 | 2. Change directory to myapp and start the web server: 35 | cd myapp; rails server (run with --help for options) 36 | 37 | 3. Go to http://localhost:3000/ and you'll see: 38 | "Welcome aboard: You're riding Ruby on Rails!" 39 | 40 | 4. Follow the guidelines to start developing your application. You can find 41 | the following resources handy: 42 | 43 | * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html 44 | * Ruby on Rails Tutorial Book: http://www.railstutorial.org/ 45 | 46 | 47 | == Debugging Rails 48 | 49 | Sometimes your application goes wrong. Fortunately there are a lot of tools that 50 | will help you debug it and get it back on the rails. 51 | 52 | First area to check is the application log files. Have "tail -f" commands 53 | running on the server.log and development.log. Rails will automatically display 54 | debugging and runtime information to these files. Debugging info will also be 55 | shown in the browser on requests from 127.0.0.1. 56 | 57 | You can also log your own messages directly into the log file from your code 58 | using the Ruby logger class from inside your controllers. Example: 59 | 60 | class WeblogController < ActionController::Base 61 | def destroy 62 | @weblog = Weblog.find(params[:id]) 63 | @weblog.destroy 64 | logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!") 65 | end 66 | end 67 | 68 | The result will be a message in your log file along the lines of: 69 | 70 | Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1! 71 | 72 | More information on how to use the logger is at http://www.ruby-doc.org/core/ 73 | 74 | Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are 75 | several books available online as well: 76 | 77 | * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) 78 | * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) 79 | 80 | These two books will bring you up to speed on the Ruby language and also on 81 | programming in general. 82 | 83 | 84 | == Debugger 85 | 86 | Debugger support is available through the debugger command when you start your 87 | Mongrel or WEBrick server with --debugger. This means that you can break out of 88 | execution at any point in the code, investigate and change the model, and then, 89 | resume execution! You need to install ruby-debug to run the server in debugging 90 | mode. With gems, use sudo gem install ruby-debug. Example: 91 | 92 | class WeblogController < ActionController::Base 93 | def index 94 | @posts = Post.all 95 | debugger 96 | end 97 | end 98 | 99 | So the controller will accept the action, run the first line, then present you 100 | with a IRB prompt in the server window. Here you can do things like: 101 | 102 | >> @posts.inspect 103 | => "[#nil, "body"=>nil, "id"=>"1"}>, 105 | #"Rails", "body"=>"Only ten..", "id"=>"2"}>]" 107 | >> @posts.first.title = "hello from a debugger" 108 | => "hello from a debugger" 109 | 110 | ...and even better, you can examine how your runtime objects actually work: 111 | 112 | >> f = @posts.first 113 | => #nil, "body"=>nil, "id"=>"1"}> 114 | >> f. 115 | Display all 152 possibilities? (y or n) 116 | 117 | Finally, when you're ready to resume execution, you can enter "cont". 118 | 119 | 120 | == Console 121 | 122 | The console is a Ruby shell, which allows you to interact with your 123 | application's domain model. Here you'll have all parts of the application 124 | configured, just like it is when the application is running. You can inspect 125 | domain models, change values, and save to the database. Starting the script 126 | without arguments will launch it in the development environment. 127 | 128 | To start the console, run rails console from the application 129 | directory. 130 | 131 | Options: 132 | 133 | * Passing the -s, --sandbox argument will rollback any modifications 134 | made to the database. 135 | * Passing an environment name as an argument will load the corresponding 136 | environment. Example: rails console production. 137 | 138 | To reload your controllers and models after launching the console run 139 | reload! 140 | 141 | More information about irb can be found at: 142 | link:http://www.rubycentral.org/pickaxe/irb.html 143 | 144 | 145 | == dbconsole 146 | 147 | You can go to the command line of your database directly through rails 148 | dbconsole. You would be connected to the database with the credentials 149 | defined in database.yml. Starting the script without arguments will connect you 150 | to the development database. Passing an argument will connect you to a different 151 | database, like rails dbconsole production. Currently works for MySQL, 152 | PostgreSQL and SQLite 3. 153 | 154 | == Description of Contents 155 | 156 | The default directory structure of a generated Ruby on Rails application: 157 | 158 | |-- app 159 | | |-- assets 160 | | | |-- images 161 | | | |-- javascripts 162 | | | `-- stylesheets 163 | | |-- controllers 164 | | |-- helpers 165 | | |-- mailers 166 | | |-- models 167 | | `-- views 168 | | `-- layouts 169 | |-- config 170 | | |-- environments 171 | | |-- initializers 172 | | `-- locales 173 | |-- db 174 | |-- doc 175 | |-- lib 176 | | |-- assets 177 | | `-- tasks 178 | |-- log 179 | |-- public 180 | |-- script 181 | |-- test 182 | | |-- fixtures 183 | | |-- functional 184 | | |-- integration 185 | | |-- performance 186 | | `-- unit 187 | |-- tmp 188 | | `-- cache 189 | | `-- assets 190 | `-- vendor 191 | |-- assets 192 | | |-- javascripts 193 | | `-- stylesheets 194 | `-- plugins 195 | 196 | app 197 | Holds all the code that's specific to this particular application. 198 | 199 | app/assets 200 | Contains subdirectories for images, stylesheets, and JavaScript files. 201 | 202 | app/controllers 203 | Holds controllers that should be named like weblogs_controller.rb for 204 | automated URL mapping. All controllers should descend from 205 | ApplicationController which itself descends from ActionController::Base. 206 | 207 | app/models 208 | Holds models that should be named like post.rb. Models descend from 209 | ActiveRecord::Base by default. 210 | 211 | app/views 212 | Holds the template files for the view that should be named like 213 | weblogs/index.html.erb for the WeblogsController#index action. All views use 214 | eRuby syntax by default. 215 | 216 | app/views/layouts 217 | Holds the template files for layouts to be used with views. This models the 218 | common header/footer method of wrapping views. In your views, define a layout 219 | using the layout :default and create a file named default.html.erb. 220 | Inside default.html.erb, call <% yield %> to render the view using this 221 | layout. 222 | 223 | app/helpers 224 | Holds view helpers that should be named like weblogs_helper.rb. These are 225 | generated for you automatically when using generators for controllers. 226 | Helpers can be used to wrap functionality for your views into methods. 227 | 228 | config 229 | Configuration files for the Rails environment, the routing map, the database, 230 | and other dependencies. 231 | 232 | db 233 | Contains the database schema in schema.rb. db/migrate contains all the 234 | sequence of Migrations for your schema. 235 | 236 | doc 237 | This directory is where your application documentation will be stored when 238 | generated using rake doc:app 239 | 240 | lib 241 | Application specific libraries. Basically, any kind of custom code that 242 | doesn't belong under controllers, models, or helpers. This directory is in 243 | the load path. 244 | 245 | public 246 | The directory available for the web server. Also contains the dispatchers and the 247 | default HTML files. This should be set as the DOCUMENT_ROOT of your web 248 | server. 249 | 250 | script 251 | Helper scripts for automation and generation. 252 | 253 | test 254 | Unit and functional tests along with fixtures. When using the rails generate 255 | command, template test files will be generated for you and placed in this 256 | directory. 257 | 258 | vendor 259 | External libraries that the application depends on. Also includes the plugins 260 | subdirectory. If the app has frozen rails, those gems also go here, under 261 | vendor/rails/. This directory is in the load path. 262 | -------------------------------------------------------------------------------- /spec/dummy/Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | # Add your own tasks in files placed in lib/tasks ending in .rake, 3 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. 4 | 5 | require File.expand_path('../config/application', __FILE__) 6 | 7 | Dummy::Application.load_tasks 8 | -------------------------------------------------------------------------------- /spec/dummy/app/assets/images/rails.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/app/assets/images/rails.png -------------------------------------------------------------------------------- /spec/dummy/app/assets/javascripts/application.js: -------------------------------------------------------------------------------- 1 | // This is a manifest file that'll be compiled into application.js, which will include all the files 2 | // listed below. 3 | // 4 | // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts, 5 | // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path. 6 | // 7 | // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the 8 | // the compiled file. 9 | // 10 | // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD 11 | // GO AFTER THE REQUIRES BELOW. 12 | // 13 | //= require jquery 14 | //= require jquery_ujs 15 | //= require_tree . 16 | -------------------------------------------------------------------------------- /spec/dummy/app/assets/stylesheets/application.css: -------------------------------------------------------------------------------- 1 | /* 2 | * This is a manifest file that'll be compiled into application.css, which will include all the files 3 | * listed below. 4 | * 5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, 6 | * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path. 7 | * 8 | * You're free to add application-wide styles to this file and they'll appear at the top of the 9 | * compiled file, but it's generally better to create a new file per style scope. 10 | * 11 | *= require_self 12 | *= require_tree . 13 | */ 14 | -------------------------------------------------------------------------------- /spec/dummy/app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | class ApplicationController < ActionController::Base 2 | protect_from_forgery 3 | end 4 | -------------------------------------------------------------------------------- /spec/dummy/app/helpers/application_helper.rb: -------------------------------------------------------------------------------- 1 | module ApplicationHelper 2 | end 3 | -------------------------------------------------------------------------------- /spec/dummy/app/mailers/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/app/mailers/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/app/mailers/sandbox_mailer.rb: -------------------------------------------------------------------------------- 1 | class SandboxMailer < ActionMailer::Base 2 | def sandbox 3 | mail from: 'some@email.com', to: 'jorge.manrubia@gmail.com', subject: 'this is an email' 4 | end 5 | end -------------------------------------------------------------------------------- /spec/dummy/app/models/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/app/models/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/app/views/layouts/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Dummy 5 | <%= stylesheet_link_tag "application", :media => "all" %> 6 | <%= javascript_include_tag "application" %> 7 | <%= csrf_meta_tags %> 8 | 9 | 10 | 11 | <%= yield %> 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /spec/dummy/app/views/sandbox_mailer/sandbox.html.erb: -------------------------------------------------------------------------------- 1 | Hi Jorge! -------------------------------------------------------------------------------- /spec/dummy/config.ru: -------------------------------------------------------------------------------- 1 | # This file is used by Rack-based servers to start the application. 2 | 3 | require ::File.expand_path('../config/environment', __FILE__) 4 | run Dummy::Application 5 | -------------------------------------------------------------------------------- /spec/dummy/config/application.rb: -------------------------------------------------------------------------------- 1 | require File.expand_path('../boot', __FILE__) 2 | 3 | require 'rails/all' 4 | 5 | Bundler.require(*Rails.groups) 6 | require "mailgun_rails" 7 | 8 | if defined?(Bundler) 9 | # If you precompile assets before deploying to production, use this line 10 | Bundler.require(*Rails.groups(:assets => %w(development test))) 11 | # If you want your assets lazily compiled in production, use this line 12 | # Bundler.require(:default, :assets, Rails.env) 13 | end 14 | 15 | module Dummy 16 | class Application < Rails::Application 17 | # Settings in config/environments/* take precedence over those specified here. 18 | # Application configuration should go into files in config/initializers 19 | # -- all .rb files in that directory are automatically loaded. 20 | 21 | # Custom directories with classes and modules you want to be autoloadable. 22 | # config.autoload_paths += %W(#{config.root}/extras) 23 | 24 | # Only load the plugins named here, in the order given (default is alphabetical). 25 | # :all can be used as a placeholder for all plugins not explicitly named. 26 | # config.plugins = [ :exception_notification, :ssl_requirement, :all ] 27 | 28 | # Activate observers that should always be running. 29 | # config.active_record.observers = :cacher, :garbage_collector, :forum_observer 30 | 31 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone. 32 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC. 33 | # config.time_zone = 'Central Time (US & Canada)' 34 | 35 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded. 36 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s] 37 | # config.i18n.default_locale = :de 38 | 39 | # Configure the default encoding used in templates for Ruby 1.9. 40 | config.encoding = "utf-8" 41 | 42 | # Configure sensitive parameters which will be filtered from the log file. 43 | config.filter_parameters += [:password] 44 | 45 | # Enable escaping HTML in JSON. 46 | config.active_support.escape_html_entities_in_json = true 47 | 48 | # Use SQL instead of Active Record's schema dumper when creating the database. 49 | # This is necessary if your schema can't be completely dumped by the schema dumper, 50 | # like if you have constraints or database-specific column types 51 | # config.active_record.schema_format = :sql 52 | 53 | # Enforce whitelist mode for mass assignment. 54 | # This will create an empty whitelist of attributes available for mass-assignment for all models 55 | # in your app. As such, your models will need to explicitly whitelist or blacklist accessible 56 | # parameters by using an attr_accessible or attr_protected declaration. 57 | # config.active_record.whitelist_attributes = true 58 | 59 | # Enable the asset pipeline 60 | config.assets.enabled = true 61 | 62 | # Version of your assets, change this if you want to expire all your assets 63 | config.assets.version = '1.0' 64 | end 65 | end 66 | -------------------------------------------------------------------------------- /spec/dummy/config/boot.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | 3 | # Set up gems listed in the Gemfile. 4 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__) 5 | 6 | require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE']) 7 | -------------------------------------------------------------------------------- /spec/dummy/config/database.yml: -------------------------------------------------------------------------------- 1 | # SQLite version 3.x 2 | # gem install sqlite3 3 | # 4 | # Ensure the SQLite 3 gem is defined in your Gemfile 5 | # gem 'sqlite3' 6 | development: 7 | adapter: sqlite3 8 | database: db/development.sqlite3 9 | pool: 5 10 | timeout: 5000 11 | 12 | # Warning: The database defined as "test" will be erased and 13 | # re-generated from your development database when you run "rake". 14 | # Do not set this db to the same as development or production. 15 | test: 16 | adapter: sqlite3 17 | database: db/test.sqlite3 18 | pool: 5 19 | timeout: 5000 20 | 21 | production: 22 | adapter: sqlite3 23 | database: db/production.sqlite3 24 | pool: 5 25 | timeout: 5000 26 | -------------------------------------------------------------------------------- /spec/dummy/config/environment.rb: -------------------------------------------------------------------------------- 1 | # Load the rails application 2 | require File.expand_path('../application', __FILE__) 3 | 4 | # Initialize the rails application 5 | Dummy::Application.initialize! 6 | -------------------------------------------------------------------------------- /spec/dummy/config/environments/development.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # In the development environment your application's code is reloaded on 5 | # every request. This slows down response time but is perfect for development 6 | # since you don't have to restart the web server when you make code changes. 7 | config.cache_classes = false 8 | 9 | # Do not eager load code on boot. 10 | config.eager_load = false 11 | 12 | # Log error messages when you accidentally call methods on nil. 13 | config.whiny_nils = true 14 | 15 | # Show full error reports and disable caching 16 | config.consider_all_requests_local = true 17 | config.action_controller.perform_caching = false 18 | 19 | # Don't care if the mailer can't send 20 | config.action_mailer.raise_delivery_errors = false 21 | 22 | # Print deprecation notices to the Rails logger 23 | config.active_support.deprecation = :log 24 | 25 | # Only use best-standards-support built into browsers 26 | config.action_dispatch.best_standards_support = :builtin 27 | 28 | # Raise exception on mass assignment protection for Active Record models 29 | # config.active_record.mass_assignment_sanitizer = :strict 30 | 31 | # Log the query plan for queries taking more than this (works 32 | # with SQLite, MySQL, and PostgreSQL) 33 | config.active_record.auto_explain_threshold_in_seconds = 0.5 34 | 35 | # Do not compress assets 36 | config.assets.compress = false 37 | 38 | # Expands the lines which load the assets 39 | config.assets.debug = true 40 | 41 | config.action_mailer.delivery_method = :mailgun 42 | config.action_mailer.mailgun_settings = { 43 | api_key: ENV['ACTION_MAILER_API_KEY'], 44 | domain: 'ACTION_MAILER_DOMAIN' 45 | } 46 | config.action_mailer.raise_delivery_errors 47 | 48 | end 49 | -------------------------------------------------------------------------------- /spec/dummy/config/environments/production.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # Code is not reloaded between requests 5 | config.cache_classes = true 6 | 7 | # Do not eager load code on boot. 8 | config.eager_load = true 9 | 10 | # Full error reports are disabled and caching is turned on 11 | config.consider_all_requests_local = false 12 | config.action_controller.perform_caching = true 13 | 14 | # Disable Rails's static asset server (Apache or nginx will already do this) 15 | config.serve_static_files = false 16 | 17 | # Compress JavaScripts and CSS 18 | config.assets.compress = true 19 | 20 | # Don't fallback to assets pipeline if a precompiled asset is missed 21 | config.assets.compile = false 22 | 23 | # Generate digests for assets URLs 24 | config.assets.digest = true 25 | 26 | # Defaults to nil and saved in location specified by config.assets.prefix 27 | # config.assets.manifest = YOUR_PATH 28 | 29 | # Specifies the header that your server uses for sending files 30 | # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache 31 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx 32 | 33 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. 34 | # config.force_ssl = true 35 | 36 | # See everything in the log (default is :info) 37 | # config.log_level = :debug 38 | 39 | # Prepend all log lines with the following tags 40 | # config.log_tags = [ :subdomain, :uuid ] 41 | 42 | # Use a different logger for distributed setups 43 | # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new) 44 | 45 | # Use a different cache store in production 46 | # config.cache_store = :mem_cache_store 47 | 48 | # Enable serving of images, stylesheets, and JavaScripts from an asset server 49 | # config.action_controller.asset_host = "http://assets.example.com" 50 | 51 | # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added) 52 | # config.assets.precompile += %w( search.js ) 53 | 54 | # Disable delivery errors, bad email addresses will be ignored 55 | # config.action_mailer.raise_delivery_errors = false 56 | 57 | # Enable threaded mode 58 | # config.threadsafe! 59 | 60 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 61 | # the I18n.default_locale when a translation can not be found) 62 | config.i18n.fallbacks = true 63 | 64 | # Send deprecation notices to registered listeners 65 | config.active_support.deprecation = :notify 66 | 67 | # Log the query plan for queries taking more than this (works 68 | # with SQLite, MySQL, and PostgreSQL) 69 | # config.active_record.auto_explain_threshold_in_seconds = 0.5 70 | end 71 | -------------------------------------------------------------------------------- /spec/dummy/config/environments/test.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb 3 | 4 | # The test environment is used exclusively to run your application's 5 | # test suite. You never need to work with it otherwise. Remember that 6 | # your test database is "scratch space" for the test suite and is wiped 7 | # and recreated between test runs. Don't rely on the data there! 8 | config.cache_classes = true 9 | 10 | # Do not eager load code on boot. 11 | config.eager_load = false 12 | 13 | # Configure static asset server for tests with Cache-Control for performance 14 | config.serve_static_files = true 15 | config.static_cache_control = "public, max-age=3600" 16 | 17 | # Log error messages when you accidentally call methods on nil 18 | config.whiny_nils = true 19 | 20 | # Show full error reports and disable caching 21 | config.consider_all_requests_local = true 22 | config.action_controller.perform_caching = false 23 | 24 | # Raise exceptions instead of rendering exception templates 25 | config.action_dispatch.show_exceptions = false 26 | 27 | # Disable request forgery protection in test environment 28 | config.action_controller.allow_forgery_protection = false 29 | 30 | # Tell Action Mailer not to deliver emails to the real world. 31 | # The :test delivery method accumulates sent emails in the 32 | # ActionMailer::Base.deliveries array. 33 | config.action_mailer.delivery_method = :test 34 | 35 | # Raise exception on mass assignment protection for Active Record models 36 | # config.active_record.mass_assignment_sanitizer = :strict 37 | 38 | # Print deprecation notices to the stderr 39 | config.active_support.deprecation = :stderr 40 | end 41 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/backtrace_silencers.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. 4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } 5 | 6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. 7 | # Rails.backtrace_cleaner.remove_silencers! 8 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/inflections.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new inflection rules using the following format 4 | # (all these examples are active by default): 5 | # ActiveSupport::Inflector.inflections do |inflect| 6 | # inflect.plural /^(ox)$/i, '\1en' 7 | # inflect.singular /^(ox)en/i, '\1' 8 | # inflect.irregular 'person', 'people' 9 | # inflect.uncountable %w( fish sheep ) 10 | # end 11 | # 12 | # These inflection rules are supported but not enabled by default: 13 | # ActiveSupport::Inflector.inflections do |inflect| 14 | # inflect.acronym 'RESTful' 15 | # end 16 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/mime_types.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new mime types for use in respond_to blocks: 4 | # Mime::Type.register "text/richtext", :rtf 5 | # Mime::Type.register_alias "text/html", :iphone 6 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/secret_token.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Your secret key for verifying the integrity of signed cookies. 4 | # If you change this key, all old signed cookies will become invalid! 5 | # Make sure the secret is at least 30 characters and all random, 6 | # no regular words or you'll be exposed to dictionary attacks. 7 | Dummy::Application.config.secret_token = '09c51ab7cd021c804bee0cfc280754db976151e77eaacc310923821bd9bbc1b649e67c9154616ee26e14df6861584ba1e845c24c65af32a54e979bb80cebacc3' 8 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/session_store.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | Dummy::Application.config.session_store :cookie_store, key: '_dummy_session' 4 | 5 | # Use the database for sessions instead of the cookie-based default, 6 | # which shouldn't be used to store highly confidential information 7 | # (create the session table with "rails generate session_migration") 8 | # Dummy::Application.config.session_store :active_record_store 9 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/wrap_parameters.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | # 3 | # This file contains settings for ActionController::ParamsWrapper which 4 | # is enabled by default. 5 | 6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. 7 | ActiveSupport.on_load(:action_controller) do 8 | wrap_parameters format: [:json] 9 | end 10 | 11 | # Disable root element in JSON by default. 12 | ActiveSupport.on_load(:active_record) do 13 | self.include_root_in_json = false 14 | end 15 | -------------------------------------------------------------------------------- /spec/dummy/config/locales/en.yml: -------------------------------------------------------------------------------- 1 | # Sample localization file for English. Add more files in this directory for other locales. 2 | # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points. 3 | 4 | en: 5 | hello: "Hello world" 6 | -------------------------------------------------------------------------------- /spec/dummy/config/routes.rb: -------------------------------------------------------------------------------- 1 | Dummy::Application.routes.draw do 2 | # The priority is based upon order of creation: 3 | # first created -> highest priority. 4 | 5 | # Sample of regular route: 6 | # match 'products/:id' => 'catalog#view' 7 | # Keep in mind you can assign values other than :controller and :action 8 | 9 | # Sample of named route: 10 | # match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase 11 | # This route can be invoked with purchase_url(:id => product.id) 12 | 13 | # Sample resource route (maps HTTP verbs to controller actions automatically): 14 | # resources :products 15 | 16 | # Sample resource route with options: 17 | # resources :products do 18 | # member do 19 | # get 'short' 20 | # post 'toggle' 21 | # end 22 | # 23 | # collection do 24 | # get 'sold' 25 | # end 26 | # end 27 | 28 | # Sample resource route with sub-resources: 29 | # resources :products do 30 | # resources :comments, :sales 31 | # resource :seller 32 | # end 33 | 34 | # Sample resource route with more complex sub-resources 35 | # resources :products do 36 | # resources :comments 37 | # resources :sales do 38 | # get 'recent', :on => :collection 39 | # end 40 | # end 41 | 42 | # Sample resource route within a namespace: 43 | # namespace :admin do 44 | # # Directs /admin/products/* to Admin::ProductsController 45 | # # (app/controllers/admin/products_controller.rb) 46 | # resources :products 47 | # end 48 | 49 | # You can have the root of your site routed with "root" 50 | # just remember to delete public/index.html. 51 | # root :to => 'welcome#index' 52 | 53 | # See how all your routes lay out with "rake routes" 54 | 55 | # This is a legacy wild controller route that's not recommended for RESTful applications. 56 | # Note: This route will make all actions in every controller accessible via GET requests. 57 | # match ':controller(/:action(/:id))(.:format)' 58 | end 59 | -------------------------------------------------------------------------------- /spec/dummy/db/seeds.rb: -------------------------------------------------------------------------------- 1 | # This file should contain all the record creation needed to seed the database with its default values. 2 | # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup). 3 | # 4 | # Examples: 5 | # 6 | # cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }]) 7 | # Mayor.create(name: 'Emanuel', city: cities.first) 8 | -------------------------------------------------------------------------------- /spec/dummy/doc/README_FOR_APP: -------------------------------------------------------------------------------- 1 | Use this README file to introduce your application and point to useful places in the API for learning more. 2 | Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries. 3 | -------------------------------------------------------------------------------- /spec/dummy/lib/assets/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/lib/assets/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/lib/tasks/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/lib/tasks/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/log/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/log/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The page you were looking for doesn't exist (404) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The page you were looking for doesn't exist.

23 |

You may have mistyped the address or the page may have moved.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /spec/dummy/public/422.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The change you wanted was rejected (422) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The change you wanted was rejected.

23 |

Maybe you tried to change something you didn't have access to.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /spec/dummy/public/500.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | We're sorry, but something went wrong (500) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

We're sorry, but something went wrong.

23 |
24 | 25 | 26 | -------------------------------------------------------------------------------- /spec/dummy/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/public/favicon.ico -------------------------------------------------------------------------------- /spec/dummy/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Ruby on Rails: Welcome aboard 5 | 174 | 187 | 188 | 189 |
190 | 203 | 204 |
205 | 209 | 210 | 214 | 215 |
216 |

Getting started

217 |

Here’s how to get rolling:

218 | 219 |
    220 |
  1. 221 |

    Use rails generate to create your models and controllers

    222 |

    To see all available options, run it without parameters.

    223 |
    2. 224 | 225 |
  2. 226 |

    Set up a default route and remove public/index.html

    227 |

    Routes are set up in config/routes.rb.

    228 |
    3. 229 | 230 |
  3. 231 |

    Create your database

    232 |

    Run rake db:create to create your database. If you're not using SQLite (the default), edit config/database.yml with your username and password.

    233 |
    4. 234 |
235 |
236 |
237 | 238 | 239 |
240 | 241 | 242 | -------------------------------------------------------------------------------- /spec/dummy/public/robots.txt: -------------------------------------------------------------------------------- 1 | # See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file 2 | # 3 | # To ban all spiders from the entire site uncomment the next two lines: 4 | # User-Agent: * 5 | # Disallow: / 6 | -------------------------------------------------------------------------------- /spec/dummy/script/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application. 3 | 4 | APP_PATH = File.expand_path('../../config/application', __FILE__) 5 | require File.expand_path('../../config/boot', __FILE__) 6 | require 'rails/commands' 7 | -------------------------------------------------------------------------------- /spec/dummy/test/fixtures/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/test/fixtures/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/test/functional/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/test/functional/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/test/integration/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/test/integration/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/test/performance/browsing_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | require 'rails/performance_test_help' 3 | 4 | class BrowsingTest < ActionDispatch::PerformanceTest 5 | # Refer to the documentation for all available options 6 | # self.profile_options = { :runs => 5, :metrics => [:wall_time, :memory] 7 | # :output => 'tmp/performance', :formats => [:flat] } 8 | 9 | def test_homepage 10 | get '/' 11 | end 12 | end 13 | -------------------------------------------------------------------------------- /spec/dummy/test/test_helper.rb: -------------------------------------------------------------------------------- 1 | ENV["RAILS_ENV"] = "test" 2 | require File.expand_path('../../config/environment', __FILE__) 3 | require 'rails/test_help' 4 | 5 | class ActiveSupport::TestCase 6 | # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order. 7 | # 8 | # Note: You'll currently still have to declare fixtures explicitly in integration tests 9 | # -- they do not yet inherit this setting 10 | fixtures :all 11 | 12 | # Add more helper methods to be used by all tests here... 13 | end 14 | -------------------------------------------------------------------------------- /spec/dummy/test/unit/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/test/unit/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/vendor/assets/javascripts/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/vendor/assets/javascripts/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/vendor/assets/stylesheets/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/vendor/assets/stylesheets/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/vendor/plugins/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jorgemanrubia/mailgun_rails/0aa70be4f9c577423e1e8a0bdd51e44519a1af93/spec/dummy/vendor/plugins/.gitkeep -------------------------------------------------------------------------------- /spec/lib/mailgun_rails/attachment_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | require 'mailgun_rails/attachment' 3 | 4 | describe MailgunRails::Attachment do 5 | describe "#send_message" do 6 | before do 7 | @mail = Mail.new() 8 | @mail.attachments["attachment.png"] = "\312\213\254\232" 9 | @mail.attachments.inline["attachment2.png"] = "\312\213\254\232" 10 | @mail.attachments["attachment.json"] = { mime_type: 'application/json', content: {cool: 'json'}.to_json } 11 | 12 | end 13 | 14 | it 'should respond to rest_client api' do 15 | attachment = MailgunRails::Attachment.new(@mail.attachments.first) 16 | attachment.respond_to?(:path).should eq(true) 17 | attachment.respond_to?(:original_filename).should eq(true) 18 | attachment.respond_to?(:content_type).should eq(true) 19 | attachment.respond_to?(:read).should eq(true) 20 | end 21 | 22 | it 'should set cid as original_filename' do 23 | attachment = MailgunRails::Attachment.new(@mail.attachments.inline.first, inline: true) 24 | attachment.original_filename.should eq(@mail.attachments.inline.first.cid) 25 | end 26 | 27 | it 'should set filename as original_filename' do 28 | attachment = MailgunRails::Attachment.new(@mail.attachments.first) 29 | attachment.original_filename.should eq(@mail.attachments.first.filename) 30 | end 31 | 32 | it 'should set filename as original_filename for hash' do 33 | attachment = MailgunRails::Attachment.new(@mail.attachments.last) 34 | attachment.original_filename.should eq(@mail.attachments.last.filename) 35 | end 36 | end 37 | end 38 | -------------------------------------------------------------------------------- /spec/lib/mailgun_rails/client_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | require 'mailgun_rails/client' 3 | 4 | describe MailgunRails::Client do 5 | let(:client){MailgunRails::Client.new(:some_api_key, :some_domain)} 6 | 7 | describe "#send_message" do 8 | it 'should make a POST rest request passing the parameters to the mailgun end point' do 9 | expected_url = "https://api:some_api_key@api.mailgun.net/v3/some_domain/messages" 10 | RestClient::Request.stub(:execute).with({ method: :post, url: expected_url, payload: { foo: :bar }, verify_ssl: true}) 11 | client.send_message foo: :bar 12 | end 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /spec/lib/mailgun_rails/deliverer_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | require 'mailgun_rails/deliverer' 3 | require 'mailgun_rails/client' 4 | require 'json' 5 | 6 | 7 | describe MailgunRails::Deliverer do 8 | describe "#deliver" do 9 | let(:api_key) { :some_api_key } 10 | let(:domain) { :some_domain } 11 | let(:mailgun_client) { double(MailgunRails::Client) } 12 | 13 | before(:each) do 14 | MailgunRails::Client.stub(:new).with(api_key, domain, true).and_return mailgun_client 15 | end 16 | 17 | it 'should invoke mailgun message transforming the basic email properties' do 18 | check_mailgun_message basic_multipart_rails_message, basic_expected_mailgun_message 19 | end 20 | 21 | it 'should invoke mailgun message transforming the mail gun variables' do 22 | check_mailgun_message message_with_mailgun_variables, basic_expected_mailgun_message.merge('v:foo' => 'bar') 23 | end 24 | 25 | it 'should invoke mailgun message transforming the mailgun options' do 26 | check_mailgun_message message_with_mailgun_options, basic_expected_mailgun_message.merge('o:foo' => 'bar') 27 | end 28 | 29 | it 'should invoke mailgun message transforming the custom headers' do 30 | check_mailgun_message message_with_custom_headers, basic_expected_mailgun_message.merge('h:foo' => 'bar') 31 | end 32 | 33 | it 'should invoke mailgun message transforming the recipient variables' do 34 | check_mailgun_message message_with_mailgun_recipient_variables, basic_expected_mailgun_message.merge('recipient-variables' => {foo: 'bar'}.to_json) 35 | end 36 | 37 | it 'should send HTML only messages' do 38 | check_mailgun_message html_rails_message, basic_expected_mailgun_message.except(:text) 39 | end 40 | 41 | it 'should send text only messages' do 42 | check_mailgun_message text_rails_message, basic_expected_mailgun_message.except(:html) 43 | end 44 | 45 | it 'should include sender and recipient names in from field' do 46 | check_mailgun_message text_rails_message_with_names, basic_expected_mailgun_message.except(:html).merge(emails_with_names) 47 | end 48 | 49 | it "should not include cc if empty array" do 50 | msg = Mail::Message.new(to: 'to@email.com', 51 | from: 'from@email.com', 52 | cc: []) 53 | expectation = { to: ['to@email.com'], 54 | from: ['from@email.com'] } 55 | check_mailgun_message msg, expectation 56 | end 57 | 58 | it "should include cc if present" do 59 | msg = Mail::Message.new(to: 'to@email.com', 60 | from: 'from@email.com', 61 | cc: 'cc@email.com') 62 | expectation = { to: ['to@email.com'], 63 | from: ['from@email.com'], 64 | cc: ['cc@email.com'] } 65 | check_mailgun_message msg, expectation 66 | end 67 | 68 | it "should include bcc if present" do 69 | msg = Mail::Message.new(to: 'to@email.com', 70 | from: 'from@email.com', 71 | bcc: 'bcc@email.com') 72 | expectation = { to: ['to@email.com'], 73 | from: ['from@email.com'], 74 | bcc: ['bcc@email.com'] } 75 | check_mailgun_message msg, expectation 76 | end 77 | 78 | it 'should include reply-to name in custom header' do 79 | msg = Mail::Message.new(to: 'to@email.com', 80 | from: 'from@email.com', 81 | reply_to: 'Reply User ') 82 | expectation = { to: ['to@email.com'], 83 | from: ['from@email.com'], 84 | 'h:Reply-To' => 'Reply User ' } 85 | check_mailgun_message msg, expectation 86 | end 87 | 88 | 89 | it 'should include attachment' do 90 | rails_message = rails_message_with_attachment 91 | attachment = double(MailgunRails::Attachment) 92 | MailgunRails::Attachment.stub(:new).with(rails_message.attachments.first, encoding: 'ascii-8bit').and_return attachment 93 | expectation = basic_expected_mailgun_message 94 | expectation[:attachment] = [attachment] 95 | check_mailgun_message rails_message, expectation 96 | end 97 | 98 | it 'should include inline attachment' do 99 | rails_message = rails_message_with_inline_attachment 100 | attachment = double(MailgunRails::Attachment) 101 | MailgunRails::Attachment.stub(:new).with(rails_message.attachments.first, encoding: 'ascii-8bit', inline: true).and_return attachment 102 | expectation = basic_expected_mailgun_message 103 | expectation[:inline] = [attachment] 104 | check_mailgun_message rails_message, expectation 105 | end 106 | 107 | it 'should include attachment of both types' do 108 | rails_message = rails_message_with_both_types_attachments 109 | attachment = double(MailgunRails::Attachment) 110 | MailgunRails::Attachment.stub(:new).with(rails_message.attachments.first, encoding: 'ascii-8bit', inline: true).and_return attachment 111 | MailgunRails::Attachment.stub(:new).with(rails_message.attachments.last, encoding: 'ascii-8bit').and_return attachment 112 | expectation = basic_expected_mailgun_message 113 | expectation[:inline] = [attachment] 114 | expectation[:attachment] = [attachment] 115 | check_mailgun_message rails_message, expectation 116 | end 117 | 118 | it "should update the Mail::Message#message_id with the id returned from mailgun" do 119 | msg = Mail::Message.new(to: 'to@email.com', from: 'from@email.com') 120 | expectation = { to: ['to@email.com'], from: ['from@email.com']} 121 | check_mailgun_message msg, expectation 122 | msg.message_id.should eq "20111114174239.25659.5817@samples.mailgun.org" 123 | end 124 | 125 | def check_mailgun_message(rails_message, mailgun_message) 126 | rest_response = double(:code => 200, :to_str => '{"message": "Queued. Thank you.","id": "<20111114174239.25659.5817@samples.mailgun.org>"}') 127 | mailgun_client.should_receive(:send_message).with(mailgun_message).and_return(rest_response) 128 | MailgunRails::Deliverer.new(api_key: api_key, domain: domain).deliver!(rails_message) 129 | end 130 | 131 | def rails_message_with_attachment 132 | msg = basic_multipart_rails_message 133 | msg.attachments["attachment.jpg"] = "\312\213\254\232" 134 | msg 135 | end 136 | 137 | def rails_message_with_inline_attachment 138 | msg = basic_multipart_rails_message 139 | msg.attachments.inline["attachment.jpg"] = "\312\213\254\232" 140 | msg 141 | end 142 | 143 | def rails_message_with_both_types_attachments 144 | msg = basic_multipart_rails_message 145 | msg.attachments.inline["attachment.jpg"] = "\312\213\254\232" 146 | msg.attachments["attachment.png"] = "\312\213\254\232" 147 | msg 148 | end 149 | 150 | def basic_multipart_rails_message 151 | this_example = self 152 | Mail::Message.new(common_rails_message_properties.merge(content_type: 'multipart/alternative')) do 153 | html_part do 154 | body this_example.html_body 155 | end 156 | 157 | text_part do 158 | body this_example.text_body 159 | end 160 | end 161 | end 162 | 163 | def html_rails_message 164 | Mail::Message.new(common_rails_message_properties.merge(content_type: 'text/html', body: html_body)) 165 | end 166 | 167 | def text_rails_message 168 | Mail::Message.new(common_rails_message_properties.merge(content_type: 'text/plain', body: text_body)) 169 | end 170 | 171 | def text_rails_message_with_names 172 | Mail::Message.new(common_rails_message_properties.merge(content_type: 'text/plain', body: text_body).merge(emails_with_names)) 173 | end 174 | 175 | def emails_with_names 176 | {from: ['Sender '], to: ['Receiver ', 'Another one ']} 177 | end 178 | 179 | def common_rails_message_properties 180 | {from: 'from@email.com', to: 'to@email.com', subject: 'some subject', reply_to: 'reply@to.com', } 181 | end 182 | 183 | def message_with_mailgun_variables 184 | message = basic_multipart_rails_message 185 | message.mailgun_variables = {foo: 'bar'} 186 | message 187 | end 188 | 189 | def message_with_mailgun_options 190 | message = basic_multipart_rails_message 191 | message.mailgun_options = {foo: 'bar'} 192 | message 193 | end 194 | 195 | def message_with_custom_headers 196 | message = basic_multipart_rails_message 197 | message.mailgun_headers = {foo: 'bar'} 198 | message 199 | end 200 | 201 | def message_with_mailgun_recipient_variables 202 | message = basic_multipart_rails_message 203 | message.mailgun_recipient_variables = {foo: 'bar'} 204 | message 205 | end 206 | 207 | def basic_expected_mailgun_message 208 | { 209 | :from => [common_rails_message_properties[:from]], 210 | :to => [common_rails_message_properties[:to]], 211 | :subject => common_rails_message_properties[:subject], 212 | 'h:Reply-To' => common_rails_message_properties[:reply_to], 213 | :text => text_body, 214 | :html => html_body 215 | } 216 | end 217 | end 218 | 219 | def html_body 220 | 'the html content' 221 | end 222 | 223 | def text_body 224 | 'the text content' 225 | end 226 | end 227 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | # This file was generated by the `rspec --init` command. Conventionally, all 2 | # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. 3 | # Require this file using `require "spec_helper"` to ensure that it is only 4 | # loaded once. 5 | # 6 | # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration 7 | 8 | require 'mailgun_rails/mail_ext' 9 | 10 | require 'action_mailer' 11 | 12 | require File.expand_path("../dummy/config/environment.rb", __FILE__) 13 | 14 | RSpec.configure do |config| 15 | 16 | config.treat_symbols_as_metadata_keys_with_true_values = true 17 | config.run_all_when_everything_filtered = true 18 | config.filter_run :focus 19 | 20 | # Run specs in random order to surface order dependencies. If you find an 21 | # order dependency and want to debug it, you can fix the order by providing 22 | # the seed, which is printed after each run. 23 | # --seed 1234 24 | config.order = 'random' 25 | end 26 | --------------------------------------------------------------------------------