fastspring-saasy 0.3.1 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/fastspring-saasy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "fastspring-saasy"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Patching"]
-  s.date = "2011-11-11"
+  s.date = "2011-11-12"
   s.description = "Ruby lib for using the FastSpring (Saas) subscription management API"
   s.email = "richard@justaddpixels.com"
   s.extra_rdoc_files = [
@@ -28,12 +28,19 @@ Gem::Specification.new do |s|
     "fastspring-saasy.gemspec",
     "lib/fastspring-saasy.rb",
     "lib/fastspring-saasy/account.rb",
+    "lib/fastspring-saasy/address.rb",
+    "lib/fastspring-saasy/base.rb",
     "lib/fastspring-saasy/customer.rb",
     "lib/fastspring-saasy/error.rb",
+    "lib/fastspring-saasy/item.rb",
+    "lib/fastspring-saasy/order.rb",
+    "lib/fastspring-saasy/payment.rb",
     "lib/fastspring-saasy/subscription.rb",
     "spec/account_spec.rb",
     "spec/customer_spec.rb",
+    "spec/fixtures/basic_order.xml",
     "spec/fixtures/basic_subscription.xml",
+    "spec/order_spec.rb",
     "spec/spec_helper.rb",
     "spec/subscription_spec.rb"
   ]

data/lib/fastspring-saasy.rb

@@ -1,6 +1,11 @@
 require 'httparty'
 
+require_relative 'fastspring-saasy/base'
 require_relative 'fastspring-saasy/account'
 require_relative 'fastspring-saasy/subscription'
 require_relative 'fastspring-saasy/customer'
+require_relative 'fastspring-saasy/order'
+require_relative 'fastspring-saasy/item'
+require_relative 'fastspring-saasy/payment'
+require_relative 'fastspring-saasy/address'
 require_relative 'fastspring-saasy/error'

data/lib/fastspring-saasy/address.rb

@@ -0,0 +1,16 @@
+module FastSpring
+  class Address
+    attr_reader :address_line_1, :address_line_2, :city, :region,
+                :region_custom, :postal_code, :country
+
+    def initialize(options)
+      @address_line_1 = options.fetch('addressLine1')
+      @address_line_2 = options.fetch('addressLine2')
+      @city = options.fetch('city')
+      @region = options.fetch('region')
+      @region_custom = options.fetch('regionCustom')
+      @postal_code = options.fetch('postalCode')
+      @country = options.fetch('country')
+    end
+  end
+end

data/lib/fastspring-saasy/base.rb

@@ -0,0 +1,58 @@
+module FastSpring
+  class Base
+    include HTTParty
+    base_uri 'https://api.fastspring.com'
+    format :xml
+    #debug_output
+
+    attr_reader :customer
+
+    def initialize(reference)
+      @auth = {:username => FastSpring::Account.fetch(:username), 
+              :password => FastSpring::Account.fetch(:password)}
+      @company = FastSpring::Account.fetch(:company)
+      @reference = reference
+    end
+
+    def self.find(reference)
+      self.new(reference).find
+    end
+
+    # Returns the current status
+    def status
+      value_for('status')
+    end
+
+    # When the status was last changed
+    def status_changed
+      DateTime.parse(value_for('statusChanged'))
+    end
+
+    def referrer
+      value_for('referrer')
+    end
+
+    def source_name
+      value_for('sourceName')
+    end
+
+    def source_key
+      value_for('sourceKey')
+    end
+
+    def source_campaign
+      value_for('sourceCampaign')
+    end
+
+    # Returns a customer object
+    def customer
+      @customer ||= Customer.new(value_for('customer'))
+    end
+
+    private
+    def value_for(attribute)
+      parsed_response.fetch(attribute)
+    end
+
+  end
+end

data/lib/fastspring-saasy/item.rb

@@ -0,0 +1,11 @@
+module FastSpring
+  class Item
+    attr_reader :product_display, :product_name, :quantity, :subscription_reference
+    def initialize(details)
+      @product_display = details.fetch('productDisplay')
+      @product_name = details.fetch('productName')
+      @quantity = details.fetch('quantity')
+      @subscription_reference = details.fetch('subscriptionReference')
+    end
+  end
+end

data/lib/fastspring-saasy/order.rb

@@ -0,0 +1,76 @@
+module FastSpring
+  class Order < Base
+    attr_reader :purchaser, :items
+    # Get the order from Saasy
+    def find
+      @response = self.class.get(base_order_path, :basic_auth => @auth)
+      self
+    end
+
+    def base_order_path
+      "/company/#{@company}/order/#{@reference}"
+    end
+
+    def items
+      @items ||= [Item.new(parsed_response['orderItems']['orderItem'])]
+    end
+
+    def payments
+      @payments ||= [Payment.new(parsed_response['payments']['payment'])]
+    end
+
+    def payment
+      payments[0]
+    end
+
+    # Return the order reference
+    def reference
+      value_for('reference')
+    end
+
+    # Was the order a test?
+    def test?
+      value_for('test') == 'true'
+    end
+
+    # Returns a DateTime object
+    def due
+      DateTime.parse(value_for('due'))
+    end
+
+    def currency
+      value_for('currency')
+    end
+
+    def origin_ip
+      value_for('originIp')
+    end
+
+    def purchaser
+      @purchaser ||= Customer.new(value_for('customer'))
+    end
+
+    def total
+      value_for('total').to_f
+    end
+
+    def tax
+      value_for('tax').to_f
+    end
+
+    def shipping
+      value_for('shipping').to_f
+    end
+
+    def address
+      @address ||= Address.new(value_for('address'))
+    end
+
+    private
+
+    def parsed_response
+      @response.parsed_response['order']
+    end
+
+  end
+end

data/lib/fastspring-saasy/payment.rb

@@ -0,0 +1,14 @@
+module FastSpring
+  class Payment
+    attr_reader :status, :status_changed, :method_type, :declined_reason,
+                :currency, :total
+
+    def initialize(details)
+      @status = details.fetch('status')
+      @status_changed = Date.parse(details.fetch('statusChanged'))
+      @declined_reason = details.fetch('declinedReason')
+      @currency = details.fetch('currency')
+      @total = details.fetch('total').to_f
+    end
+  end
+end

data/lib/fastspring-saasy/subscription.rb

@@ -1,26 +1,12 @@
 require 'date'
 
 module FastSpring
-  class Subscription
-    include HTTParty
-    base_uri 'https://api.fastspring.com'
-    format :xml
-    #debug_output
-
-    attr_reader :customer
+  class Subscription < Base
 
     # Get the subscription from Saasy
-    def initialize(reference)
-      @auth = {:username => FastSpring::Account.fetch(:username), 
-              :password => FastSpring::Account.fetch(:password)}
-      @company = FastSpring::Account.fetch(:company)
-      @reference = reference
+    def find
       @response = self.class.get(base_subscription_path, :basic_auth => @auth)
-    end
-
-    # Find a subscription by reference
-    def self.find(reference)
-      self.new(reference)
+      self
     end
 
     # Returns the base path for a subscription
@@ -28,16 +14,6 @@ module FastSpring
       "/company/#{@company}/subscription/#{@reference}"
     end
 
-    # Subscription status
-    def status
-      value_for('status')
-    end
-
-    # When the status was last changed
-    def status_changed
-      DateTime.parse(value_for('statusChanged'))
-    end
-
     # The reason for a status change
     def status_reason
       value_for('statusReason')
@@ -53,22 +29,6 @@ module FastSpring
       value_for('cancelable') == 'true'
     end
 
-    def referrer
-      value_for('referrer')
-    end
-
-    def source_name
-      value_for('sourceName')
-    end
-
-    def source_key
-      value_for('sourceKey')
-    end
-
-    def source_campaign
-      value_for('sourceCampaign')
-    end
-
     # Subscription product name
     def product_name
       value_for('productName')
@@ -83,11 +43,6 @@ module FastSpring
       Date.parse(value_for('end'))
     end
 
-    # Returns a customer object
-    def customer
-      @customer ||= Customer.new(value_for('customer'))
-    end
-
     # Cancel the subscription
     def destroy
       self.class.delete(base_subscription_path, :basic_auth => @auth)
@@ -108,10 +63,6 @@ module FastSpring
       @response.parsed_response['subscription']
     end
 
-    def value_for(attribute)
-      parsed_response.fetch(attribute)
-    end
-
   end
 end
 

data/spec/fixtures/basic_order.xml

@@ -0,0 +1,57 @@
+<order>
+  <reference>TEST-0RD3R</reference>
+  <status>completed</status>
+  <statusChanged>2010-08-15T00:00:00.000Z</statusChanged>
+  <test>false</test>
+  <due>2010-08-15T00:00:00.000Z</due>
+  <currency>GBP</currency>
+  <referrer>acme_web</referrer>
+  <originIp>123.456.789.0</originIp>
+  <total>10.00</total>
+  <tax>1.00</tax>
+  <shipping>0.0</shipping>
+  <sourceName/>
+  <sourceKey/>
+  <sourceCampaign/>
+  <customer>
+    <firstName/>
+    <lastName/>
+    <company/>
+    <email/>
+    <phoneNumber/>
+  </customer>
+  <purchaser>
+    <firstName/>
+    <lastName/>
+    <company/>
+    <email/>
+    <phoneNumber/>
+  </purchaser>
+  <address>
+    <addressLine1/>
+    <addressLine2/>
+    <city/>
+    <region/>
+    <regionCustom/>
+    <postalCode/>
+    <country/>
+  </address>
+  <orderItems>
+    <orderItem>
+      <productDisplay/>
+      <productName/>
+      <quantity>0</quantity>
+      <subscriptionReference/>
+    </orderItem>
+  </orderItems>
+  <payments>
+    <payment>
+      <status>open | request | requested | acceptance | accepted | fulfillment | fulfilled | completion | completed | canceled | failed</status>
+      <statusChanged>2010-08-15T00:00:00.000Z</statusChanged>
+      <methodType>paypal | creditcard | test | check | purchase-order | free</methodType>
+      <declinedReason>internal-error | unsupported-country | expired-card | declined | risk | processor-risk | connection | unknown | cc-address-verification | cc-cvv | voice-auth</declinedReason>
+      <currency/>
+      <total>0.0</total>
+    </payment>
+  </payments>
+</order>

data/spec/order_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/fastspring-saasy.rb'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper.rb'))
+
+describe FastSpring::Order do
+  before do
+    FastSpring::Account.setup do |config|
+      config[:username] = 'admin'
+      config[:password] = 'test'
+      config[:company] = 'acme'
+    end
+  end
+
+  context 'url for orders' do
+    subject { FastSpring::Order.find('test_ref') }
+    before do
+      stub_request(:get, "https://admin:test@api.fastspring.com/company/acme/order/test_ref").
+        to_return(:status => 200, :body => "", :headers => {})
+    end
+
+    it 'returns the path for the company and reference' do
+      subject.base_order_path.should == "/company/acme/order/test_ref"
+    end
+  end
+
+  context 'order details' do
+    subject { FastSpring::Order.find('test_ref') }
+    let(:customer) { mock(:customer) }
+    let(:address) { mock(:address) }
+    let(:item) { mock(:item) }
+    let(:payment) { mock(:payment) }
+
+    before do
+      stub_request(:get, "https://admin:test@api.fastspring.com/company/acme/order/test_ref").
+        to_return(stub_http_response_with('basic_order.xml'))
+      FastSpring::Customer.stub(:new => customer)
+      FastSpring::Address.stub(:new => address)
+      FastSpring::Item.stub(:new => item)
+      FastSpring::Payment.stub(:new => payment)
+    end
+
+    it 'returns the status' do
+      subject.status.should == 'completed'
+    end
+
+    it 'returns when the status was changed' do
+      subject.status_changed.should be_an_instance_of(DateTime)
+    end
+
+    it 'returns the order reference' do
+      subject.reference.should == 'TEST-0RD3R'
+    end
+
+    it 'returns the test status' do
+      subject.test?.should be_false
+    end
+
+    it 'returns the due date' do
+      subject.due.should be_an_instance_of(DateTime)
+    end
+
+    it 'returns the currency code' do
+      subject.currency.should == 'GBP'
+    end
+
+    it 'returns the referrer' do
+      subject.referrer.should == 'acme_web'
+    end
+
+    it 'returns the origin ip' do
+      subject.origin_ip.should == '123.456.789.0'
+    end
+
+    it 'returns the purchaser' do
+      subject.purchaser.should == customer
+    end
+
+    it 'returns the total' do
+      subject.total.should == 10.00
+    end
+
+    it 'returns the tax' do
+      subject.tax.should == 1.00
+    end
+
+    it 'returns the shipping' do
+      subject.shipping.should == 0.0
+    end
+
+    it 'returns the address' do
+      subject.address.should == address
+    end
+
+    context 'items' do
+      it 'has an order item' do
+        subject.items.should == [item]
+      end
+    end
+
+    it 'has a payment' do
+      subject.payment.should == payment
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastspring-saasy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-11 00:00:00.000000000Z
+date: 2011-11-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70301329265660 !ruby/object:Gem::Requirement
+  requirement: &70174611931540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70301329265660
+  version_requirements: *70174611931540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70301329263260 !ruby/object:Gem::Requirement
+  requirement: &70174612187520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70301329263260
+  version_requirements: *70174612187520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70301329261120 !ruby/object:Gem::Requirement
+  requirement: &70174612371500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70301329261120
+  version_requirements: *70174612371500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70301329258540 !ruby/object:Gem::Requirement
+  requirement: &70174615205380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70301329258540
+  version_requirements: *70174615205380
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70301329256600 !ruby/object:Gem::Requirement
+  requirement: &70174615396940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *70301329256600
+  version_requirements: *70174615396940
 description: Ruby lib for using the FastSpring (Saas) subscription management API
 email: richard@justaddpixels.com
 executables: []
@@ -85,12 +85,19 @@ files:
 - fastspring-saasy.gemspec
 - lib/fastspring-saasy.rb
 - lib/fastspring-saasy/account.rb
+- lib/fastspring-saasy/address.rb
+- lib/fastspring-saasy/base.rb
 - lib/fastspring-saasy/customer.rb
 - lib/fastspring-saasy/error.rb
+- lib/fastspring-saasy/item.rb
+- lib/fastspring-saasy/order.rb
+- lib/fastspring-saasy/payment.rb
 - lib/fastspring-saasy/subscription.rb
 - spec/account_spec.rb
 - spec/customer_spec.rb
+- spec/fixtures/basic_order.xml
 - spec/fixtures/basic_subscription.xml
+- spec/order_spec.rb
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
 homepage: http://github.com/patchfx/fastspring
@@ -108,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4459669591776827499
+      hash: -4339639904534215693
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: