fauxmachine-cheddargetter 0.1.2

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/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Atlantic Dominion Solutions
+
+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,30 @@
+= CheddarGetter
+
+
+12/28 added tracked item methods
+TODO: update the tests with the new method
+
+Wrapper for the Cheddar Getter API. Currently limited to the subset of API calls we actually use...
+
+== Installation
+
+  gem install fauxmachine-cheddargetter -s http://gemcutter.org/
+
+== Usage
+
+Create a CheddarGetter object with your username (email), password, and product code:
+  
+  @cheddar_getter = CheddarGetter.new('me@mysite.com', 'password', 'MY_PRODUCT')
+
+Now you can call methods that correspond to the CheddarGetter API. For example, to get a list of all plans:
+
+  @cheddar_getter.plans
+  
+For the available methods and more detailed information on each, see the RDocs and Cheddar Getter API:
+  
+* RDocs: http://rdoc.info/projects/ads/cheddargetter
+* Cheddar Getter API: https://cheddargetter.com/api
+
+== Copyright
+
+Copyright (c) 2009 Atlantic Dominion Solutions. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cheddargetter"
+    gem.summary = "Ruby wrapper for the CheddarGetter API"
+    gem.description = "Ruby wrapper for the CheddarGetter API"
+    gem.email = "keston@fauxmachine.com"
+    gem.homepage = "http://github.com/fauxmachine/cheddargetter"
+    gem.authors = ["Atlantic Dominion Solutions","Fauxmachine LLC"]
+    gem.add_dependency "httparty"
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "fakeweb"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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']
+  spec.spec_opts = ['-c']
+end
+Spec::Rake::SpecTask.new(:specdoc) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['-cf', 's']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cheddargetter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/cheddargetter.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fauxmachine-cheddargetter}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Atlantic Dominion Solutions", "Fauxmachine LLC"]
+  s.date = %q{2009-12-28}
+  s.description = %q{Ruby wrapper for the CheddarGetter API}
+  s.email = %q{keston@fauxmachine.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cheddargetter.gemspec",
+     "lib/cheddargetter.rb",
+     "spec/cheddargetter_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/spec_watcher.rb"
+  ]
+  s.homepage = %q{http://github.com/fauxmachine/cheddargetter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby wrapper for the CheddarGetter API}
+  s.test_files = [
+    "spec/cheddargetter_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/spec_watcher.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<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end
+

data/lib/cheddargetter.rb

@@ -0,0 +1,134 @@
+require 'rubygems'
+require 'httparty'
+
+class CheddarGetter
+  include HTTParty
+  
+  class Error < StandardError; end
+  
+  def initialize(username, password, product_code)
+    @product_code = product_code
+    self.class.basic_auth(username, password)
+  end
+  
+  # Returns an array of all plans:
+  #
+  #   [{"name" => "Little", "code" => "LITTLE", "recurringChargeAmount" => "1.00", etc...},
+  #    {"name" => "Big",    "code" => "BIG",    "recurringChargeAmount" => "100.00", etc..}]
+  def plans
+    response = get("/plans/get/productCode/#{@product_code}")
+    normalize_collection(response, 'plans', 'plan')
+  end
+  
+  # Returns the requested plan as a hash:
+  #
+  #   {"name" => "Little", "code" => "LITTLE", "recurringChargeAmount" => "1.00", etc...}
+  def plan(plan_code)
+    response = get("/plans/get/productCode/#{@product_code}/code/#{plan_code}")
+    normalize(response, 'plans', 'plan')
+  end
+  
+  def customers
+    response = get("/customers/get/productCode/#{@product_code}")
+    normalize_collection(response, 'customers', 'customer')
+  rescue Error => e # HACK! the api is inconsitent about returning empty nodes vs. sending errors
+    if e.message =~ /no customers found/i
+      return []
+    else
+      raise
+    end
+  end
+
+  def customer(customer_code)
+    response = get("/customers/get/productCode/#{@product_code}/code/#{customer_code}")
+    normalize(response, 'customers', 'customer')
+  end
+  
+  # Pass an attributes hash for the new customer:
+  # 
+  #   :code       => 'CUSTOMER-1',            # required
+  #   :firstName  => 'Justin',                # required
+  #   :lastName   => 'Blake',                 # required
+  #   :email      => 'justin@adsdevshop.com', # required
+  #   :company    => 'ADS',                   # optional
+  #   :subscription => {
+  #     :planCode     => "INDY",          # required
+  #     :ccFirstName  => "Justin",        # required unless plan is free
+  #     :ccLastName   => "Blake",         # required unless plan is free
+  #     :ccNumber     => "numbers only",  # required unless plan is free
+  #     :ccExpiration => "MM-YYYY",       # required unless plan is free
+  #     :ccZip        => "5 digits only"  # required unless plan is free
+  #   }
+  #
+  # Returns the customer:
+  #
+  #   {"firstName" => "Justin", "lastName" => "Blake", etc...}
+  def create_customer(attributes)
+    response = post("/customers/new/productCode/#{@product_code}", :body => attributes)
+    normalize(response, 'customers', 'customer')
+  end
+  
+  # Attributes are the same as #create_customer
+  # Only included attributes will be udpated.
+  # Credit Card information is only required if the plan is not free and
+  # no credit card information is already saved.
+  def update_customer(customer_code, attributes)
+    response = post("/customers/edit/productCode/#{@product_code}/code/#{customer_code}", :body => attributes)
+    normalize(response, 'customers', 'customer')
+  end
+  
+  # Adding support for tracked items
+  # Quantity is only required when the increment quantity is > 1
+  
+  def add_item_quantity(customer_code, item_code, attributes=nil)
+    response = post("/customers/add-item-quantity/productCode/#{@product_code}/code/#{customer_code}/itemCode/#{item_code}", :body => attributes)
+    normalize(response, 'customers', 'customer')
+  end
+  
+  def remove_item_quantity(customer_code, item_code, attributes=nil)
+    response = post("/customers/remove-item-quantity/productCode/#{@product_code}/code/#{customer_code}/itemCode/#{item_code}", :body => attributes)
+    normalize(response, 'customers', 'customer')
+  end
+  
+  # Allows tracked item quantity to be set to any number (even 0!)
+  
+  def set_item_quantity(customer_code, item_code, attributes)
+    response = post("/customers/set-item-quantity/productCode/#{@product_code}/code/#{customer_code}/itemCode/#{item_code}", :body => attributes)
+    normalize(response, 'customers', 'customer')
+  end
+  
+  # Allows for a custom tracked item to be added
+  
+  def add_charge(customer_code, item_code, attributes)
+    response = post("/customers/add-charge/productCode/#{@product_code}/code/#{customer_code}/itemCode/#{item_code}", :body => attributes)
+    normalize(response, 'customers', 'customer')
+  end
+  
+  private
+  
+  def get(path)
+    request(:get, path)
+  end
+  
+  def post(path, options = {})
+    request(:post, path, options)
+  end
+
+  def request(method, path, options = {})
+    path = "https://cheddargetter.com/xml" + path
+    response = self.class.send(method, path, options)
+    raise Error.new(response['error']) if response['error']
+    response
+  end
+  
+  def normalize(response, parent_node, child_node)
+    return [] unless response[parent_node]
+    response[parent_node][child_node]
+  end
+  
+  def normalize_collection(response, parent_node, child_node)
+    children = normalize(response, parent_node, child_node)
+    children = [children] unless children.is_a?(Array)
+    children
+  end
+end

data/spec/cheddargetter_spec.rb

@@ -0,0 +1,130 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "an instance of CheddarGetter" do
+  before(:all) do
+    CheddarGetter.stub!(:basic_auth)
+    @cheddar_getter = CheddarGetter.new('my_username', 'my_password', 'MY_PRODUCT')
+  end
+  
+  it "should use the supplied username and password for basic auth" do
+    CheddarGetter.should_receive(:basic_auth).with('my_username', 'my_password')
+    CheddarGetter.new('my_username', 'my_password', 'MY_PRODUCT')
+  end
+  
+  describe 'calling #plans' do
+    it "should return an empty array if there are no plans" do
+      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<plans></plans>")
+      @cheddar_getter.plans.should == []
+    end
+
+    it "should return the plan in an array if there is one plan" do
+      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<plans><plan>plan1</plan></plans>")
+      plans = @cheddar_getter.plans
+      plans.length.should == 1
+      plans.should include('plan1')
+    end
+    
+    it "should return the plans in an array if there are multiple plans" do
+      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<plans><plan>plan1</plan><plan>plan2</plan></plans>")
+      plans = @cheddar_getter.plans
+      plans.length.should == 2
+      plans.should include('plan1')
+      plans.should include('plan2')
+    end
+
+    it "should raise if an error is returned" do
+      mock_request(:get, "/plans/get/productCode/MY_PRODUCT", "<error>the message</error>")
+      lambda { @cheddar_getter.plans }.should raise_error(CheddarGetter::Error, 'the message')
+    end
+  end
+  
+  describe 'calling #plan(plan_code)' do
+    it "should return the requested plan if the plan code is valid" do
+      (1..3).each do |i|
+        mock_request(:get, "/plans/get/productCode/MY_PRODUCT/code/MY_PLAN#{i}", "<plans><plan>plan#{i}</plan></plans>")
+        @cheddar_getter.plan("MY_PLAN#{i}").should == "plan#{i}"
+      end
+    end
+    
+    it "should raise if the plan code is not valid" do
+      mock_request(:get, "/plans/get/productCode/MY_PRODUCT/code/BAD_CODE", "<error>bad code</error>")
+      lambda { @cheddar_getter.plan('BAD_CODE') }.should raise_error(CheddarGetter::Error, 'bad code')
+    end
+  end
+
+  describe 'calling #customers' do
+    it "should return an empty array if there are no customers" do
+      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<customers></customers>")
+      @cheddar_getter.customers.should == []
+    end
+    
+    it "should return an empty array if there is a stupid, inconsistent error about there being no customers" do
+      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<error>Bad request: No customers found</error>")
+      @cheddar_getter.customers.should == []
+    end
+
+    it "should return the customer in an array if there is one customer" do
+      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<customers><customer>customer1</customer></customers>")
+      customers = @cheddar_getter.customers
+      customers.length.should == 1
+      customers.should include('customer1')
+    end
+    
+    it "should return the customers in an array if there are multiple customers" do
+      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<customers><customer>customer1</customer><customer>customer2</customer></customers>")
+      customers = @cheddar_getter.customers
+      customers.length.should == 2
+      customers.should include('customer1')
+      customers.should include('customer2')
+    end
+    
+    it "should raise if an error is returned" do
+      mock_request(:get, "/customers/get/productCode/MY_PRODUCT", "<error>the message</error>")
+      lambda { @cheddar_getter.customers }.should raise_error(CheddarGetter::Error, 'the message')
+    end
+  end
+
+  describe 'calling #customer(customer_code)' do
+    it "should return the requested customer if the customer code is valid" do
+      (1..3).each do |i|
+        mock_request(:get, "/customers/get/productCode/MY_PRODUCT/code/MY_CUSTOMER#{i}", "<customers><customer>customer#{i}</customer></customers>")
+        @cheddar_getter.customer("MY_CUSTOMER#{i}").should == "customer#{i}"
+      end
+    end
+    
+    it "should raise if the customer code is not valid" do
+      mock_request(:get, "/customers/get/productCode/MY_PRODUCT/code/BAD_CODE", "<error>bad code</error>")
+      lambda { @cheddar_getter.customer('BAD_CODE') }.should raise_error(CheddarGetter::Error, 'bad code')
+    end
+  end
+  
+  describe 'calling #create_customer(attributes)' do
+    it "should return the created customer" do
+      mock_request(:post, "/customers/new/productCode/MY_PRODUCT", "<customers><customer>new customer</customer></customers>")
+      @cheddar_getter.create_customer(:name => 'justin', :age => 12).should == "new customer"
+    end
+    
+    it "should raise if an error is returned" do
+      mock_request(:post, "/customers/new/productCode/MY_PRODUCT", "<error>failed create</error>")
+      lambda { @cheddar_getter.create_customer(:name => 'justin') }.should raise_error(CheddarGetter::Error, 'failed create')
+    end
+  end
+  
+  describe 'calling #update_customer(customer_code, attributes)' do
+    it "should return the updated customer" do
+      mock_request(:post, "/customers/edit/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<customers><customer>updated customer</customer></customers>")
+      @cheddar_getter.update_customer('MY_CUSTOMER', :name => "new name").should == "updated customer"
+    end
+    
+    it "should raise if an error is returned" do
+      mock_request(:post, "/customers/edit/productCode/MY_PRODUCT/code/MY_CUSTOMER", "<error>failed update</error>")
+      lambda { @cheddar_getter.update_customer('MY_CUSTOMER', :name => "new name") }.should raise_error(CheddarGetter::Error, 'failed update')
+    end
+  end
+  
+  def mock_request(method, request_path, response_xml)
+    request_path.gsub!(/^\//, '')
+    options = { :body => response_xml, :content_type =>  "text/xml" }
+    FakeWeb.register_uri(method, "https://cheddargetter.com/xml/#{request_path}", options)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cheddargetter'
+require 'spec'
+require 'spec/autorun'
+require 'fakeweb'
+
+# Let's keep these specs self-contained.
+# All web service requests should be mocked.
+FakeWeb.allow_net_connect = false
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/spec_watcher.rb

@@ -0,0 +1,26 @@
+#
+# Config for watchr: http://github.com/mynyml/watchr
+#
+
+def specdoc
+  puts
+  puts "=" * 50
+  puts
+  system("rake specdoc")
+end
+
+# run specdoc on startup
+specdoc
+
+# watch the spec and lib dirs
+watch('spec/.+_spec\.rb') { |m| system("spec -c #{m[0]}") }
+watch('lib/(.*)\.rb')     { |m| system("spec -c spec/#{m[1]}_spec.rb") }
+
+# run all tests if spec helper changes
+watch('spec/spec_helper.rb') { |m| system("rake spec") }
+
+# Ctrl-\ runs specdoc
+Signal.trap('QUIT') { specdoc }
+ 
+# Ctrl-C quits
+Signal.trap('INT') { abort("\n") }

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: fauxmachine-cheddargetter
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Atlantic Dominion Solutions
+- Fauxmachine LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby wrapper for the CheddarGetter API
+email: keston@fauxmachine.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cheddargetter.gemspec
+- lib/cheddargetter.rb
+- spec/cheddargetter_spec.rb
+- spec/spec_helper.rb
+- spec/spec_watcher.rb
+has_rdoc: true
+homepage: http://github.com/fauxmachine/cheddargetter
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the CheddarGetter API
+test_files: 
+- spec/cheddargetter_spec.rb
+- spec/spec_helper.rb
+- spec/spec_watcher.rb