mailercity 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@mailercity

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rob Forman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Mailercity
+
+Ruby bindings for Mailercity API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mailercity'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mailercity
+
+## Usage
+
+Use this:
+```ruby
+Mailercity::UserMailer.welcome_email(:user_email => "rob@robforman.com").deliver
+```
+
+In order to send to the below mail in Mailercity:
+```ruby
+UserMailer.welcome_email(:user_email => "rob@robforman.com").deliver
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/mailercity.rb

@@ -0,0 +1,68 @@
+require "faraday"
+require "mailercity/helper"
+require "mailercity/version"
+require 'mailercity/errors/authentication_error'
+
+module Mailercity
+  @@api_base = 'https://mailercity.onthecity.org'
+  @@api_key = nil
+
+  def self.api_base=(api_base)
+     @@api_base = api_base
+   end
+
+   def self.api_base
+     @@api_base
+   end
+
+  def self.api_url(url='')
+    @@api_base + url
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.request(path, params)
+    raise AuthenticationError.new('No API key provided.  (HINT: set your API key using "Mailercity.api_key = <API-KEY>".') unless api_key
+    response = Faraday.post(api_url(path), params, "X-Api-Key" => Mailercity.api_key)
+    # TODO: CATCH ALL EXCEPTIONS (like URI::InvalidURIError) AND RAISE MY OWN ERROR
+  end
+
+  def self.const_missing(const_name)
+    new_class = Class.new(super_class=Message)
+
+    # Non-obvious: we assign it to a const in order to name.
+    const_set(const_name, new_class)
+  end
+
+
+  class Message
+    include Mailercity::Helper
+    attr_reader :template, :params
+
+    def initialize(args)
+      @template = args.fetch(:template)
+      @params = args.fetch(:params)
+    end
+
+    def mailer_name
+      underscore self.class.name.split(/::/).last
+    end
+
+    def deliver
+      response = Mailercity.request("/#{mailer_name}/#{template}", params)
+      response.status == 200
+    end
+
+    private
+
+    def self.method_missing(method_name, args, &block)
+      new(template: method_name, params: args)
+    end
+  end
+end

data/lib/mailercity/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Mailercity
+  class AuthenticationError < StandardError
+  end
+end

data/lib/mailercity/helper.rb

@@ -0,0 +1,14 @@
+module Mailercity
+  module Helper
+    # From activesupport/lib/active_support/inflector/methods.rb, line 77
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/mailercity/version.rb

@@ -0,0 +1,3 @@
+module Mailercity
+  VERSION = "0.0.1"
+end

data/mailercity.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mailercity/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rob Forman"]
+  gem.email         = ["rob@robforman.com"]
+  gem.description   = %q{Ruby bindings for Mailercity API}
+  gem.summary       = %q{Mailercity is a central email repository and sending service.}
+  gem.homepage      = "https://github.com/robforman/mailercity"
+
+  gem.add_dependency('faraday')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('webmock')
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mailercity"
+  gem.require_paths = ["lib"]
+  gem.version       = Mailercity::VERSION
+end

data/spec/mailercity_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+require_relative "../lib/mailercity"
+
+Mailercity.api_base = "http://testhost"
+Mailercity.api_key = "testkey"
+
+describe Mailercity do
+  def stub_post(url, params, options={})
+    status = options.fetch(:status, 200)
+    api_key = options.fetch(:api_key, Mailercity.api_key)
+    stub_request(:post, url).with(:body => params, :headers => {'X-Api-Key' => api_key}).to_return(:status => status, :body => "", :headers => {})
+  end
+
+  it "can create dynamic mailer classes and template methods while passing appropriate parameters" do
+    mail = Mailercity::MyTestMailer.my_test_template(:user_email => "rob@robforman.com")
+    mail.should be_kind_of Mailercity::Message
+  end
+
+  describe ".deliver" do
+    context "without http error" do
+      it "should post and return true" do
+        stub = stub_post("http://testhost/my_test_mailer/my_test_template", {"user_email"=>"rob@robforman.com"})
+        Mailercity::MyTestMailer.my_test_template(:user_email => "rob@robforman.com").deliver.should == true
+      end
+    end
+
+    context "with http error" do
+      it "should fail to post and return false" do
+        stub = stub_post("http://testhost/my_test_mailer/my_test_template", {"user_email"=>"rob@robforman.com"}, :status => 403)
+        Mailercity::MyTestMailer.my_test_template(:user_email => "rob@robforman.com").deliver.should == false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'webmock/rspec'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: mailercity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rob Forman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby bindings for Mailercity API
+email:
+- rob@robforman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mailercity.rb
+- lib/mailercity/errors/authentication_error.rb
+- lib/mailercity/helper.rb
+- lib/mailercity/version.rb
+- mailercity.gemspec
+- spec/mailercity_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robforman/mailercity
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Mailercity is a central email repository and sending service.
+test_files:
+- spec/mailercity_spec.rb
+- spec/spec_helper.rb