ryanwood-mousetrap 0.5.6

data/.document

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

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+spec/integration/settings.yml
+script/cheddar_getter.yml

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jon Larkowski
+
+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,25 @@
+h1. Mousetrap
+
+_CheddarGetter API Client in Ruby_
+
+Docs coming Real Soon Now (TM).
+
+
+h2. Tests
+
+h3. Unit Tests
+
+Run RSpec tests with the @rake spec@ task.
+
+h3. Integration Smoke Test
+
+This test runs against the actual CheddarGetter service, using a test Product
+that you create.
+
+# Set up a CheddarGetter account.
+# Add a Product with a code named:  @MOUSETRAP_TEST@
+# Add a Plan with a code named:  @TEST@
+# Put your credentials into a _spec/integration/settings.yml_ file.
+# Run the tests with: @spec -c -fn spec/integration/smoke_test.rb@
+
+Copyright (c) 2009 Hashrocket. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ryanwood-mousetrap"
+    gem.summary = %Q{CheddarGetter API Client in Ruby}
+    gem.description = %Q{CheddarGetter API Client in Ruby}
+    gem.email = "ryan.wood@gmail.com"
+    gem.homepage = "http://github.com/ryanwood/mousetrap"
+    gem.authors = ["Jon Larkowski", "Sandro Turriate", "Wolfram Arnold", "Corey Grusden", "Cameron Cox", "Ryan Wood"]
+    gem.add_dependency 'httparty', '>= 0.4.2'
+    gem.add_development_dependency "activesupport", '>= 2.3.3'
+    gem.add_development_dependency "rspec", '>= 1.2.9'
+    gem.add_development_dependency 'factory_girl', '>= 1.2.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.spec_opts = ['--options', 'spec/spec.opts']
+  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 :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 = "mousetrap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.6

data/lib/mousetrap/customer.rb

@@ -0,0 +1,190 @@
+module Mousetrap
+  class Customer < Resource
+    attr_accessor \
+      :id,
+      :code,
+      :email,
+      :first_name,
+      :last_name,
+      :company,
+      :subscription
+
+    def update_tracked_item_quantity(item_code, quantity = 1)
+      tracked_item_resource = if quantity == quantity.abs
+        'add-item-quantity'
+      else
+        'remove-item-quantity'
+      end
+
+      attributes = {
+        :itemCode => item_code,
+        :quantity => quantity.abs
+      }
+
+      response = self.class.put_resource 'customers', tracked_item_resource, code, attributes
+      raise response['error'] if response['error']
+      response
+    end
+
+    def add_item_quantity(item_code, quantity = 1)
+      update_tracked_item_quantity(item_code, quantity)
+    end
+
+    def remove_item_quantity(item, quantity = 1)
+      update_tracked_item_quantity(item_code, -quantity)
+    end
+
+    def add_custom_charge(item_code, amount = 1.0, quantity = 1, description = nil)
+      attributes = {
+        :chargeCode  => item_code,
+        :eachAmount  => amount,
+        :quantity    => quantity,
+        :description => description
+      }
+
+      response = self.class.put_resource 'customers', 'add-charge', code, attributes
+      raise response['error'] if response['error']
+      response
+    end
+
+    def subscription_attributes=(attributes)
+      self.subscription = Subscription.new attributes
+    end
+
+    def attributes
+      {
+        :id         => id,
+        :code       => code,
+        :email      => email,
+        :first_name => first_name,
+        :last_name  => last_name,
+        :company    => company
+      }
+    end
+
+    def attributes_for_api
+      # TODO: superclass?
+      self.class.attributes_for_api(attributes, new_record?)
+    end
+
+    def attributes_for_api_with_subscription
+      raise "Must have subscription" unless subscription
+      a = attributes_for_api
+      a[:subscription] = subscription.attributes_for_api
+      a
+    end
+
+    def cancel
+      member_action 'cancel' unless new_record?
+    end
+
+    def new?
+      if api_customer = self.class[code]
+        self.id = api_customer.id
+
+        return false
+      else
+        return true
+      end
+    end
+
+    def save
+      new? ? create : update
+    end
+
+    def switch_to_plan(plan_code)
+      raise "Can only call this on an existing CheddarGetter customer." unless exists?
+
+      attributes = { :planCode => plan_code }
+      self.class.put_resource('customers', 'edit-subscription', code, attributes)
+
+      # TODO: Refresh self with reload here?
+    end
+
+    def self.all
+      response = get_resources 'customers'
+
+      if response['error']
+        if response['error'] =~ /No customers found/
+          return []
+        else
+          raise response['error']
+        end
+      end
+
+      build_resources_from response
+    end
+
+    def self.create(attributes)
+      object = new(attributes)
+      object.send(:create)
+      object
+    end
+
+    def self.new_from_api(attributes)
+      customer = new(attributes_from_api(attributes))
+      subscription_attrs = attributes['subscriptions']['subscription']
+      customer.subscription = Subscription.new_from_api(subscription_attrs.kind_of?(Array) ? subscription_attrs.first : subscription_attrs)
+      customer
+    end
+
+    def self.update(customer_code, attributes)
+      customer = new(attributes)
+      customer.code = customer_code
+      customer.send :update
+    end
+
+
+    protected
+
+    def self.plural_resource_name
+      'customers'
+    end
+
+    def self.singular_resource_name
+      'customer'
+    end
+
+    def self.attributes_for_api(attributes, new_record = true)
+      mutated_hash = {
+        :email     => attributes[:email],
+        :firstName => attributes[:first_name],
+        :lastName  => attributes[:last_name],
+        :company   => attributes[:company]
+      }
+      mutated_hash.merge!(:code => attributes[:code]) if new_record
+      mutated_hash
+    end
+
+    def self.attributes_from_api(attributes)
+      {
+        :id         => attributes['id'],
+        :code       => attributes['code'],
+        :first_name => attributes['firstName'],
+        :last_name  => attributes['lastName'],
+        :company    => attributes['company'],
+        :email      => attributes['email']
+      }
+    end
+
+    def create
+      response = self.class.post_resource 'customers', 'new', attributes_for_api_with_subscription
+
+      raise response['error'] if response['error']
+
+      returned_customer = self.class.build_resource_from response
+      self.id = returned_customer.id
+      response
+    end
+
+    def update
+      if subscription
+        response = self.class.put_resource 'customers', 'edit', code, attributes_for_api_with_subscription
+      else
+        response = self.class.put_resource 'customers', 'edit-customer', code, attributes_for_api
+      end
+
+      raise response['error'] if response['error']
+    end
+  end
+end

data/lib/mousetrap/invoice.rb

@@ -0,0 +1,41 @@
+module Mousetrap
+  class Invoice < Resource
+    attr_accessor \
+      :id,
+      :number,
+      :billing_date,
+      :created_at
+
+    def initialize(hash = {})
+      super(self.class.attributes_from_api(hash))
+    end
+
+    protected
+
+    def self.plural_resource_name
+      'invoices'
+    end
+
+    def self.singular_resource_name
+      'invoice'
+    end
+
+    def attributes
+      {
+        :id           => id,
+        :number       => number,
+        :billing_date => billing_date,
+        :created_at   => created_at
+      }
+    end
+
+    def self.attributes_from_api(attributes)
+      {
+        :id           => attributes['id'],
+        :number       => attributes['number'],
+        :billing_date => attributes['billingDatetime'],
+        :created_at   => attributes['createdDatetime']
+      }
+    end
+  end
+end

data/lib/mousetrap/plan.rb

@@ -0,0 +1,34 @@
+module Mousetrap
+  class Plan < Resource
+    attr_accessor \
+      :code,
+      :name,
+      :items,
+      :recurring_charge_amount
+
+    def self.all
+      response = get_resources plural_resource_name
+      return [] unless response['plans']
+      build_resources_from response
+    end
+
+    protected
+
+    def self.plural_resource_name
+      'plans'
+    end
+
+    def self.singular_resource_name
+      'plan'
+    end
+
+    def self.attributes_from_api(attributes)
+      {
+        :code                    => attributes['code'],
+        :name                    => attributes['name'],
+        :items                   => attributes['items'],
+        :recurring_charge_amount => attributes['recurringChargeAmount']
+      }
+    end
+  end
+end

data/lib/mousetrap/resource.rb

@@ -0,0 +1,147 @@
+module Mousetrap
+  class Resource
+    include HTTParty
+    headers 'User-Agent' => 'Mousetrap Ruby Client'
+    base_uri 'https://cheddargetter.com'
+
+    def initialize(hash={})
+      hash.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    def self.[](code)
+      # Example error message:
+      #
+      # { "error" => "Resource not found: Customer not found for
+      #    code=cantfindme within productCode=MOUSETRAP_TEST"}
+
+      response = get_resource plural_resource_name, code
+
+      if response['error']
+        if response['error'] =~ /not found/
+          return nil
+        else
+          raise response['error']
+        end
+      end
+
+      build_resource_from response
+    end
+
+    def self.destroy_all
+      all.each { |object| object.destroy }
+    end
+
+    def self.exists?(code)
+      !self[code].nil?
+    end
+
+    def self.new_from_api(attributes)
+      new(attributes_from_api(attributes))
+    end
+
+    def destroy
+      member_action 'delete' unless new_record?
+    end
+
+    def exists?
+      self.class.exists?(code)
+    end
+
+    def new?
+      id.nil?
+    end
+
+    alias new_record? new?
+
+
+    protected
+
+    def self.build_resource_from(response)
+      resource_attributes = extract_resources(response)
+      new_from_api(resource_attributes)
+    end
+
+    def self.build_resources_from(response)
+      resources = []
+
+      response_resources = extract_resources(response)
+
+      if response_resources.is_a?(Array)
+        extract_resources(response).each do |resource_attributes|
+          resources << new_from_api(resource_attributes)
+        end
+      else
+        resources << new_from_api(response_resources)
+      end
+
+      resources
+    end
+
+    def self.delete_resource(resource, code)
+      member_action(resource, 'delete', code)
+    end
+
+    def self.extract_resources(response)
+      response[plural_resource_name][singular_resource_name]
+    end
+
+    def self.get_resource(resource, code)
+      get resource_path(resource, 'get', code)
+    rescue Errno::ECONNREFUSED
+      raise_api_is_down
+    end
+
+    def self.get_resources(resource)
+      get resource_path(resource, 'get')
+    rescue Errno::ECONNREFUSED
+      raise_api_is_down
+    end
+
+    def self.member_action(resource, action, code, attributes = nil)
+      path = resource_path(resource, action, code)
+
+      if attributes
+        post path, :body => attributes
+      else
+        post path
+      end
+    rescue Errno::ECONNREFUSED
+      raise_api_is_down
+    end
+
+    def self.post_resource(resource, action, attributes)
+      path = resource_path(resource, action)
+      post path, :body => attributes
+    rescue Errno::ECONNREFUSED
+      raise_api_is_down
+    end
+
+    def self.put_resource(resource, action, code, attributes)
+      member_action(resource, action, code, attributes)
+    end
+
+    def self.raise_api_unsupported_error
+      raise NotImplementedError, API_UNSUPPORTED
+    end
+
+    def self.raise_api_is_down
+      raise ApiDown, "CheddarGetter is currently down"
+    end
+
+    def self.resource_path(resource, action, code = nil)
+      path = "/xml/#{resource}/#{action}/productCode/#{uri_encode(Mousetrap.product_code)}"
+      path += "/code/#{uri_encode(code)}" if code
+      path
+    end
+
+    def self.uri_encode(value)
+      URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def member_action(action)
+      self.class.member_action(self.class.plural_resource_name, action, code)
+    end
+  end
+end

data/lib/mousetrap/subscription.rb

@@ -0,0 +1,160 @@
+module Mousetrap
+  class Subscription < Resource
+    # Attributes we send _to_ the API.
+    attr_accessor \
+      :plan_code,
+      :billing_first_name,
+      :billing_last_name,
+      :credit_card_number,
+      :credit_card_expiration_month,
+      :credit_card_expiration_year,
+      :credit_card_code,
+      :billing_country,
+      :billing_address,
+      :billing_city,
+      :billing_state,
+      :billing_zip_code,
+      :plan,
+
+      :customer_code # belongs to customer
+
+    # Attributes that come _from_ the API.
+    attr_reader \
+      :id,
+      :canceled_at,
+      :created_at,
+      :credit_card_expiration_date,
+      :credit_card_last_four_digits,
+      :credit_card_type,
+      :invoices,
+      :items
+
+    def self.[](code)
+      raise_api_unsupported_error
+    end
+
+    def self.all
+      raise_api_unsupported_error
+    end
+
+    def self.destroy_all
+      raise_api_unsupported_error
+    end
+
+    def self.exists?(code)
+      raise_api_unsupported_error
+    end
+
+    def current_invoice
+      invoice_attributes = if invoices['invoice'].kind_of?(Array)
+        invoices['invoice'][0]
+      else
+        invoices['invoice']
+      end
+
+      Invoice.new(invoice_attributes)
+    end
+
+    def attributes
+      {
+        :id                           => id,
+        :plan_code                    => plan_code,
+        :billing_first_name           => billing_first_name,
+        :billing_last_name            => billing_last_name,
+        :credit_card_number           => credit_card_number,
+        :credit_card_expiration_month => credit_card_expiration_month,
+        :credit_card_expiration_year  => credit_card_expiration_year,
+        :credit_card_code             => credit_card_code,
+        :billing_country              => billing_country,
+        :billing_address              => billing_address,
+        :billing_city                 => billing_city,
+        :billing_state                => billing_state,
+        :billing_zip_code             => billing_zip_code,
+      }
+    end
+
+    def attributes_for_api
+      self.class.attributes_for_api(attributes)
+    end
+
+    def destroy
+      self.class.raise_api_unsupported_error
+    end
+
+    def exists?
+      self.class.raise_api_unsupported_error
+    end
+
+    def self.new_from_api(attributes)
+      subscription = new(attributes_from_api(attributes))
+      subscription.plan = Plan.new_from_api(attributes['plans']['plan'])
+      subscription
+    end
+
+    def self.update(customer_code, attributes)
+      mutated_attributes = attributes_for_api(attributes)
+
+      mutated_attributes.delete_if { |k, v| v.blank? }
+
+      response = put_resource(
+        'customers',
+        'edit-subscription',
+        customer_code,
+        mutated_attributes
+      )
+
+      raise response['error'] if response['error']
+    end
+
+
+    protected
+
+    attr_writer \
+      :id,
+      :canceled_at,
+      :created_at,
+      :credit_card_expiration_date,
+      :credit_card_last_four_digits,
+      :credit_card_type,
+      :items,
+      :invoices
+
+    def self.plural_resource_name
+      'subscriptions'
+    end
+
+    def self.singular_resource_name
+      'subscription'
+    end
+
+    def self.attributes_for_api(attributes)
+      {
+        :planCode     => attributes[:plan_code],
+        :ccFirstName  => attributes[:billing_first_name],
+        :ccLastName   => attributes[:billing_last_name],
+        :ccNumber     => attributes[:credit_card_number],
+        :ccExpMonth   => ("%02d" % attributes[:credit_card_expiration_month] if attributes[:credit_card_expiration_month]),
+        :ccExpYear    => attributes[:credit_card_expiration_year],
+        :ccCardCode   => attributes[:credit_card_code],
+        :ccCountry    => attributes[:billing_country],
+        :ccAddress    => attributes[:billing_address],
+        :ccCity       => attributes[:billing_city],
+        :ccState      => attributes[:billing_state],
+        :ccZip        => attributes[:billing_zip_code]
+      }
+    end
+
+    def self.attributes_from_api(attributes)
+      {
+        :id                           => attributes['id'],
+        :canceled_at                  => attributes['canceledDatetime'],
+        :created_at                   => attributes['createdDatetime'],
+        :credit_card_expiration_date  => attributes['ccExpirationDate'],
+        :credit_card_last_four_digits => attributes['ccLastFour'],
+        :credit_card_type             => attributes['ccType'],
+        :invoices                     => attributes['invoices'],
+        :items                        => attributes['items']
+      }
+    end
+  end
+end