hashrocket-my_emma 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Hashrocket
+
+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.textile

@@ -0,0 +1,7 @@
+h1. my_emma
+
+Description goes here.
+
+h2. Copyright
+
+Copyright (c) 2009 Hashrocket. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "my_emma"
+    gem.summary = %Q{Ruby wrapper for the MyEmma Remote Signup API}
+    gem.email = "dev@hashrocket.com"
+    gem.homepage = "http://github.com/hashrocket/my_emma"
+    gem.authors = ["Jim Remsik", "Sandro Turriate"]
+    gem.add_dependency('jnunemaker-httparty', '>= 0.4.3')
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "my_emma #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/core_ext.rb

@@ -0,0 +1,47 @@
+# Copied from ActiveSupport 2.3.2
+class Hash
+  # Return a new hash with all keys converted to strings.
+  def stringify_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+
+  # Destructively convert all keys to strings.
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+
+  # Return a new hash with all keys converted to symbols.
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+  # Destructively convert all keys to symbols.
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+
+  alias_method :to_options,  :symbolize_keys
+  alias_method :to_options!, :symbolize_keys!
+
+  # Validate all keys in a hash match *valid keys, raising ArgumentError on a mismatch.
+  # Note that keys are NOT treated indifferently, meaning if you use strings for keys but assert symbols
+  # as keys, this will fail.
+  #
+  # ==== Examples
+  #   { :name => "Rob", :years => "28" }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key(s): years"
+  #   { :name => "Rob", :age => "28" }.assert_valid_keys("name", "age") # => raises "ArgumentError: Unknown key(s): name, age"
+  #   { :name => "Rob", :age => "28" }.assert_valid_keys(:name, :age) # => passes, raises nothing
+  def assert_valid_keys(*valid_keys)
+    unknown_keys = keys - [valid_keys].flatten
+    raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+  end
+end

data/lib/httparty_ext.rb

@@ -0,0 +1,17 @@
+HTTParty::Request.class_eval do
+  class << self
+    attr_accessor :debug
+  end
+  self.debug = false
+
+  def perform_with_debug
+    if self.class.debug
+      puts "HTTParty making #{http_method::METHOD} request to:"
+      puts uri
+    end
+    perform_without_debug
+  end
+
+  alias_method :perform_without_debug, :perform
+  alias_method :perform, :perform_with_debug
+end

data/lib/my_emma.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'core_ext'
+require 'httparty'
+require 'httparty_ext'
+require 'rfc822'
+
+class MyEmma
+  autoload :Response, 'my_emma/response'
+
+  include HTTParty
+  base_uri "https://app.e2ma.net"
+
+  class Error < RuntimeError; end
+
+  REQUIRED_CREDENTIALS = [
+    'emma_account_id',
+    'signup_post',
+    'username',
+    'password',
+  ].sort.freeze
+
+  def self.signup(email, parameters={})
+    if email_valid?(email)
+      parameters.merge! credentials.merge(:emma_member_email => email)
+      Response.new post('/app/view:RemoteSignup', :query => parameters)
+    end
+  end
+
+  def self.credentials=(h={})
+    h.stringify_keys!
+    raise Error, "Missing required credential(s): #{(REQUIRED_CREDENTIALS - h.keys.sort).inspect}" unless h.keys.sort == REQUIRED_CREDENTIALS
+    @@credentials = h
+  end
+
+  def self.credentials
+    @@credentials ||= {}
+  end
+
+  private
+
+  def self.email_valid?(email)
+    email && email =~ RFC822::EmailAddress
+  end
+end

data/lib/my_emma/response.rb

@@ -0,0 +1,34 @@
+class MyEmma
+  class Response
+    attr_reader :response, :code
+    alias to_s response
+
+    def initialize(response)
+      @response = response
+      @code = response.to_i
+    end
+
+    def failed?
+      code <= 0
+    end
+
+    def success?
+      code > 0
+    end
+
+    RESPONSES = {
+      :added_member? => 1,
+      :updated_member? => 2,
+      :member_exists? => 3,
+      :authentication_failed? => -1,
+      :add_member_failed? => -2,
+      :update_member_failed? => -3
+    }
+
+    RESPONSES.each do |name, error_code|
+      define_method name do
+        code == error_code
+      end
+    end
+  end
+end

data/lib/rfc822.rb

@@ -0,0 +1,30 @@
+#
+# RFC822 Email Address Regex
+# --------------------------
+# 
+# Originally written by Cal Henderson
+# c.f. http://iamcal.com/publish/articles/php/parsing_email/
+#
+# Translated to Ruby by Tim Fletcher, with changes suggested by Dan Kubb.
+#
+# Licensed under a Creative Commons Attribution-ShareAlike 2.5 License
+# http://creativecommons.org/licenses/by-sa/2.5/
+# ro@me.com =~ RFC822::EmailAddress
+module RFC822
+  EmailAddress = begin
+    qtext = '[^\\x0d\\x22\\x5c\\x80-\\xff]'
+    dtext = '[^\\x0d\\x5b-\\x5d\\x80-\\xff]'
+    atom = '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-' +
+      '\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+'
+    quoted_pair = '\\x5c[\\x00-\\x7f]'
+    domain_literal = "\\x5b(?:#{dtext}|#{quoted_pair})*\\x5d"
+    quoted_string = "\\x22(?:#{qtext}|#{quoted_pair})*\\x22"
+    domain_ref = atom
+    sub_domain = "(?:#{domain_ref}|#{domain_literal})"
+    word = "(?:#{atom}|#{quoted_string})"
+    domain = "#{sub_domain}(?:\\x2e#{sub_domain})*"
+    local_part = "#{word}(?:\\x2e#{word})*"
+    addr_spec = "#{local_part}\\x40#{domain}"
+    pattern = /\A#{addr_spec}\z/
+  end
+end

data/my_emma.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{my_emma}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jim Remsik", "Sandro Turriate"]
+  s.date = %q{2009-06-24}
+  s.email = %q{dev@hashrocket.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "MIT_LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/core_ext.rb",
+     "lib/httparty_ext.rb",
+     "lib/my_emma.rb",
+     "lib/my_emma/response.rb",
+     "lib/rfc822.rb",
+     "my_emma.gemspec",
+     "spec/my_emma/response_spec.rb",
+     "spec/my_emma_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/hashrocket/my_emma}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Ruby wrapper for the MyEmma Remote Signup API}
+  s.test_files = [
+    "spec/my_emma/response_spec.rb",
+     "spec/my_emma_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jnunemaker-httparty>, [">= 0.4.3"])
+    else
+      s.add_dependency(%q<jnunemaker-httparty>, [">= 0.4.3"])
+    end
+  else
+    s.add_dependency(%q<jnunemaker-httparty>, [">= 0.4.3"])
+  end
+end

data/spec/my_emma/response_spec.rb

@@ -0,0 +1,63 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper.rb")
+
+describe MyEmma::Response do
+  describe "#initialize" do
+    it "instantiates with a response code" do
+      expect{ MyEmma::Response.new('1') }.should_not raise_error
+    end
+
+    it "transforms the response code to an integer" do
+      response = MyEmma::Response.new('1')
+      response.code.should == 1
+    end
+  end
+
+  describe "successful response" do
+    it "succeeded" do
+      response = MyEmma::Response.new('1')
+      response.success?.should be_true
+    end
+
+    it "added a member" do
+      response = MyEmma::Response.new('1')
+      response.added_member?.should be_true
+    end
+
+    it "updated a member" do
+      response = MyEmma::Response.new('2')
+      response.updated_member?.should be_true
+    end
+
+    it "indicates member already exists" do
+      response = MyEmma::Response.new('3')
+      response.member_exists?.should be_true
+    end
+  end
+
+  describe "failure" do
+    it "failed" do
+      response = MyEmma::Response.new('-1')
+      response.failed?.should be_true
+    end
+
+    it "authentication" do
+      response = MyEmma::Response.new('-1')
+      response.authentication_failed?.should be_true
+    end
+
+    it "member add failed" do
+      response = MyEmma::Response.new('-2')
+      response.add_member_failed?.should be_true
+    end
+
+    it "member update failed" do
+      response = MyEmma::Response.new('-3')
+      response.update_member_failed?.should be_true
+    end
+
+    it "non-integer response is a failure" do
+      response = MyEmma::Response.new('<html>blah</html>')
+      response.failed?.should be_true
+    end
+  end
+end

data/spec/my_emma_spec.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe MyEmma do
+  it "defines the host" do
+    MyEmma.base_uri.should == "https://app.e2ma.net"
+  end
+
+  describe "setting credentials" do
+    it "requires signup_post, emma_account_id, username, password" do
+      lambda {
+        MyEmma.credentials = {}
+      }.should raise_error(MyEmma::Error)
+    end
+  end
+
+  describe "#signup" do
+    it "posts to the RemoteSignup endpoint" do
+      MyEmma.should_receive(:post).with('/app/view:RemoteSignup', anything)
+      MyEmma.signup('test@example.com')
+    end
+
+    it "posts the email to the endpoint" do
+      MyEmma.should_receive(:post).with(anything, :query => hash_including(:emma_member_email => 'test@example.com'))
+      MyEmma.signup('test@example.com')
+    end
+
+    it "returns nil if email is invalid" do
+      MyEmma.signup('invalid_email_address').should be_nil
+      MyEmma.signup(nil).should be_nil
+    end
+
+    it "returns an integer on success" do
+      MyEmma.stub!(:post => 1)
+      MyEmma.signup("me@example.com").success?.should be_true
+    end
+
+    it "returns a negative integer on failure" do
+      MyEmma.stub!(:post => -1)
+      MyEmma.signup("me@example.com").failed?.should be_true
+    end
+
+    it "adds credentials to the post request" do
+      MyEmma.stub!(:credentials => {:username => 'someuser'})
+      MyEmma.should_receive(:post).with(anything, :query => hash_including(:username => 'someuser'))
+      MyEmma.signup('email@example.com')
+    end
+
+    it "adds additional parameters to the query" do
+      MyEmma.stub!(:credentials => {:username => 'someuser'})
+      MyEmma.should_receive(:post).with(anything, :query => hash_including(:username => 'someuser', :first_name => "John", :last_name => "Smith", :emma_member_email => 'email@example.com'))
+      MyEmma.signup('email@example.com', :first_name => "John", :last_name => "Smith")
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'my_emma'
+require 'spec'
+require 'spec/autorun'
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: hashrocket-my_emma
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jim Remsik
+- Sandro Turriate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
+description: 
+email: dev@hashrocket.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .document
+- .gitignore
+- MIT_LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/core_ext.rb
+- lib/httparty_ext.rb
+- lib/my_emma.rb
+- lib/my_emma/response.rb
+- lib/rfc822.rb
+- my_emma.gemspec
+- spec/my_emma/response_spec.rb
+- spec/my_emma_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hashrocket/my_emma
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the MyEmma Remote Signup API
+test_files: 
+- spec/my_emma/response_spec.rb
+- spec/my_emma_spec.rb
+- spec/spec_helper.rb