benchwarmer 0.0.3

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+	gem 'fakeweb'
+	gem 'guard-rspec'
+  gem "jeweler", "~> 1.8.3"
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+	gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    ffi (1.0.11)
+    git (1.2.5)
+    guard (1.0.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fakeweb
+  guard-rspec
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Brian Getting
+
+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.rdoc

@@ -0,0 +1,74 @@
+= Benchwarmer
+
+Benchwarmer is a Ruby gem that provides a wrapper for interacting with the {Benchmark Email API}[http://www.benchmarkemail.com/API/Doc].
+
+== Requirements
+
+You will need a {Benchmark Email account}[http://www.benchmarkemail.com/Register]. Once you have your Benchmark account set up, you will need your username and password to access the API.
+
+== Installation
+
+  (sudo) gem install benchwarmer
+
+== Usage
+
+The first step is to login to the Benchmark Email API and get your API access token, which you will want to store for later use. Keep in mind that each time you "login" to the API, a new token will be generated. Token management is discussed further down. Don't forget that your "username" can also be your email address, depending on how you have set up your Benchmark Email account. 
+
+  token = Benchwarmer::API.login('username/email', 'password')
+  > "833a7c7ff759414699efe73ac90cff98" # => Store this value for later use.
+
+Once you have your API access token, the next step is to create a Benchwarmer object:
+
+  b = Benchwarmer::API.new(token)
+
+You can also override the default configuration by passing in your own when initializing:
+
+  b = Benchwarmer::API.new(token, {:secure => true, :timeout => 60, :api_version => '1.0'})
+
+You can then run any of the methods that you find in the {Benchmark Email API Documentation}[http://www.benchmarkemail.com/API/Library] against it. Simply convert the names to the more Ruby-like underscored versions (e.g. listGetContactDetails becomes list_get_contact_details).
+
+  # Retrieve all contact lists
+  b.list_get('', 1, 100, '', '')
+  
+  # Add contacts to a list
+  contacts = [
+    { :email => 'sample@subscriber.com',
+      :firstname => 'Bob',
+      :lastname => 'Smith' }
+  ]
+  b.list_add_contacts('list_id', contacts, 0) # => Change to '1' for double opt-in
+  
+  # Create a new contact list
+  b.list_create('My List Name') #	=> Returns the ID of the newly created list
+
+== Dealing With Tokens
+
+Each time you "login" to the API to retrieve an access token, the Benchmark Email API will generate a new access token. The problem with this is that if you don't store your token and instead login each time, tokens will build up. Since having a lot of tokens that grant access to your account via the API is a bad idea, {Benchwarmer}[http://rubygems.org/gems/benchwarmer] provides methods to manage your tokens:
+
+  # List the valid API tokens for this account
+  Benchwarmer::API.token_get('username/email', 'password', {:secure => true})
+
+  # Add a new API token
+  Benchwarmer::API.token_add('username/email', 'password', {:secure => true})
+  
+	# Delete an API token
+  Benchwarmer::API.token_add('username/email', 'password', 'api_token_to_delete', {:secure => true})
+
+== Travis Build Status
+
+{<img src="http://travis-ci.org/terra-firma/benchwarmer.png" />}[http://travis-ci.org/terra-firma/benchwarmer]
+
+== Contributing to Benchwarmer
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Terra Firma Design & Consulting. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "benchwarmer"
+  gem.homepage = "http://github.com/terra-firma/benchwarmer"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby wrapper for the Benchmark Email API.}
+  gem.description = %Q{Benchwarmer is a Ruby gem that provides a wrapper for interacting with the “Benchmark Email” API.}
+  gem.email = "brian@terra-firma-design.com"
+  gem.authors = ["Brian Getting"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "benchwarmer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/benchwarmer.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "benchwarmer"
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Getting"]
+  s.date = "2012-01-31"
+  s.description = "Benchwarmer is a Ruby gem that provides a wrapper for interacting with the \u{201c}Benchmark Email\u{201d} API."
+  s.email = "brian@terra-firma-design.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "benchwarmer.gemspec",
+    "lib/benchwarmer.rb",
+    "lib/benchwarmer/api.rb",
+    "spec/benchwarmer_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/terra-firma/benchwarmer"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A Ruby wrapper for the Benchmark Email API."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/benchwarmer.rb

@@ -0,0 +1,5 @@
+require 'openssl'
+require 'securerandom'
+require 'xmlrpc/client'
+
+require 'benchwarmer/api'

data/lib/benchwarmer/api.rb

@@ -0,0 +1,94 @@
+module Benchwarmer
+  class API
+    # Blank Slate
+    instance_methods.each do |m|
+      undef_method m unless m.to_s =~ /^__|object_id|method_missing|respond_to?|to_s|inspect/
+    end
+    
+    # Benchmark Email API Documentation: http://www.benchmarkemail.com/API/Library
+    BENCHMARK_API_VERSION = "1.0"
+    DEFAULTS = {
+      :api_version => BENCHMARK_API_VERSION,
+      :secure => false,
+      :timeout => nil
+    }
+
+    # Initialize with an API token and config options
+    def initialize(api_token, config = {})
+      opts = DEFAULTS.merge(config).freeze
+      @api_client = XMLRPC::Client.new2("#{opts[:secure] ? 'https' : 'http'}://api.benchmarkemail.com/#{opts[:api_version]}/", nil, opts[:timeout])
+      @api_token = api_token
+    end
+
+    def method_missing(api_method, *args) # :nodoc:
+      @api_client.call(camelize_api_method_name(api_method.to_s), @api_token, *args)
+    rescue XMLRPC::FaultException => error
+      super if error.message.include?("unsupported method called:")
+      raise APIError.new(error)
+    end
+    
+    def respond_to?(api_method) # :nodoc:
+      @api_client.call(api_method, @api_token)
+    rescue XMLRPC::FaultException => error
+      error.message.include?("unsupported method called:") ? false : true
+    end
+    
+    # Token management methods
+    #
+    # Each time you "login", a new token is generated with access to the B.E. API.
+    # This means that you should store a single token and use it over and over,
+    # preventing a build-up of tokens.
+    #
+    # Our hope is that in the future B.E. will make the following changes
+    # with regard to API access tokens:
+    #
+    # - Provide an interface for account holders to manage their API tokens.
+    # - Remove the ability to login with username, password.
+    # - Add OAuth2 so that the "access_token" can be used in the same way that
+    #   "API tokens" are currently used.
+    #
+    # In other words, make it more like Mailchimp.
+    
+    def self.login(username, password, config = {})
+      api_client(config)
+      @api_client.call('login', username, password)
+    end
+    
+    # Get a list of the tokens
+    def self.token_get(username, password, config = {})
+      api_client(config)
+      @api_client.call("tokenGet", username, password)
+    end
+
+    # Add a new token (generated randomly)
+    def self.token_add(username, password, config = {})
+      api_client(config)
+      @api_client.call("tokenAdd", username, password, SecureRandom.urlsafe_base64(20))
+    end
+
+    # Delete an existing token
+    def self.token_delete(username, password, token, config = {})
+      api_client(config)
+      @api_client.call("tokenDelete", username, password, token)
+    end
+    
+    private
+    
+    def self.api_client(options)
+      opts = DEFAULTS.merge(options).freeze
+      @api_client = XMLRPC::Client.new2("#{opts[:secure] ? 'https' : 'http'}://api.benchmarkemail.com/#{opts[:api_version]}/", nil, opts[:timeout])
+    end
+    
+    def camelize_api_method_name(str)
+      str.to_s[0].chr.downcase + str.gsub(/(?:^|_)(.)/) { $1.upcase }[1..str.size]
+    end
+    
+  end
+  
+  class APIError < StandardError
+    def initialize(error)
+      super("(#{error.faultCode}) #{error.message}")
+    end
+  end
+
+end

data/spec/benchwarmer_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module Benchwarmer
+  describe API do
+
+    it "requires an API token on initialization" do
+      expect {Benchwarmer::API.new}.should raise_error(ArgumentError)
+    end
+
+    it "also accepts config options on initialization" do
+      expect {Benchwarmer::API.new('api_token', {:secure => true})}.should_not raise_error(ArgumentError)
+    end
+    
+    it "requires a username and password for class methods" do
+      expect {Benchwarmer::API.login('password')}.should raise_error(ArgumentError)
+      expect {Benchwarmer::API.token_get('password')}.should raise_error(ArgumentError)
+      expect {Benchwarmer::API.token_add('password')}.should raise_error(ArgumentError)
+      expect {Benchwarmer::API.token_delete('password')}.should raise_error(ArgumentError)
+    end
+    
+    it "requires a token to delete" do
+      expect {Benchwarmer::API.token_delete('username', 'password')}.should raise_error(ArgumentError)
+    end
+    
+    it "also accepts config options on class methods" do
+      expect {Benchwarmer::API.login('username', 'password', {:secure => true})}.should_not raise_error(ArgumentError)
+      expect {Benchwarmer::API.token_get('username', 'password', {:secure => true})}.should_not raise_error(ArgumentError)
+      expect {Benchwarmer::API.token_add('username', 'password', {:secure => true})}.should_not raise_error(ArgumentError)
+      expect {Benchwarmer::API.token_delete('username', 'password', 'token', {:secure => true})}.should_not raise_error(ArgumentError)  
+    end
+    
+    # TODO: Need a way to mock XMLRPC requests.
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fakeweb'
+require 'benchwarmer'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do |config|
+  config.before(:each) do
+    FakeWeb.clean_registry
+    # Set up any variables needed here...
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: benchwarmer
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Brian Getting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70260519996900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70260519996900
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70260519995900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70260519995900
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70260519995020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70260519995020
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70260519994260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70260519994260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70260519993260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70260519993260
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70260519992600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70260519992600
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70260520020740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70260520020740
+description: Benchwarmer is a Ruby gem that provides a wrapper for interacting with
+  the “Benchmark Email” API.
+email: brian@terra-firma-design.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- benchwarmer.gemspec
+- lib/benchwarmer.rb
+- lib/benchwarmer/api.rb
+- spec/benchwarmer_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/terra-firma/benchwarmer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2717363225508213416
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Benchmark Email API.
+test_files: []