fastspring-saasy 0.3.0

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gem 'httparty'
+gem 'rake'
+
+group :development do
+  gem 'bundler'
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    multi_xml (0.4.1)
+    rake (0.9.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.0)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    webmock (1.7.7)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  httparty
+  jeweler
+  rake
+  rspec
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Richard Patching
+
+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,23 @@
+= fastspring-saasy
+
+Ruby library to access the FastSpring Saasy API.
+
+== Installation
+
+  gem install fastspring-saasy
+
+== Usage
+
+  require 'fastspring-saasy'
+  FastSpring::Subscription.new('company', 'reference', 'user', 'password')
+
+== Todo
+
+* Support update
+* Support the order API
+ 
+== Copyright
+
+Copyright (c) 2011 Richard Patching. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,35 @@
+# 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.name = "fastspring-saasy"
+  gem.homepage = "http://github.com/patchfx/fastspring"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby lib for using the FastSpring (Saasy) API}
+  gem.description = %Q{Ruby lib for using the FastSpring (Saas) subscription management API}
+  gem.email = "richard@justaddpixels.com"
+  gem.authors = ["Richard Patching"]
+  gem.add_development_dependency 'httparty', '~> 0.8.1'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fastspring #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/fastspring-saasy.gemspec

@@ -0,0 +1,68 @@
+# 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 = "fastspring-saasy"
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Richard Patching"]
+  s.date = "2011-11-10"
+  s.description = "Ruby lib for using the FastSpring (Saas) subscription management API"
+  s.email = "richard@justaddpixels.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fastspring-saasy.gemspec",
+    "lib/fastspring-saasy.rb",
+    "lib/fastspring-saasy/customer.rb",
+    "lib/fastspring-saasy/error.rb",
+    "lib/fastspring-saasy/subscription.rb",
+    "spec/customer_spec.rb",
+    "spec/fixtures/basic_subscription.xml",
+    "spec/spec_helper.rb",
+    "spec/subscription_spec.rb"
+  ]
+  s.homepage = "http://github.com/patchfx/fastspring"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby lib for using the FastSpring (Saasy) 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_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<httparty>, ["~> 0.8.1"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<httparty>, ["~> 0.8.1"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<httparty>, ["~> 0.8.1"])
+  end
+end
+

data/lib/fastspring-saasy.rb

@@ -0,0 +1,5 @@
+require 'httparty'
+
+require_relative 'fastspring-saasy/subscription'
+require_relative 'fastspring-saasy/customer'
+require_relative 'fastspring-saasy/error'

data/lib/fastspring-saasy/customer.rb

@@ -0,0 +1,14 @@
+module FastSpring
+  class Customer
+    attr_accessor :first_name, :last_name, :company, :email, :phone_number
+
+    def initialize(details)
+      @first_name = details.fetch('firstName')
+      @last_name = details.fetch('lastName')
+      @company = details.fetch('company')
+      @email = details.fetch('email')
+      @phone_number = details.fetch('phoneNumber')
+    end
+
+  end
+end

data/lib/fastspring-saasy/error.rb

@@ -0,0 +1,13 @@
+module FastSpring
+  module Error
+
+    class NotFound < StandardError
+      attr_reader :response
+
+      def initialize(response=nil)
+        @response  = response
+      end
+    end
+
+  end
+end

data/lib/fastspring-saasy/subscription.rb

@@ -0,0 +1,111 @@
+require 'date'
+
+module FastSpring
+  class Subscription
+    include HTTParty
+    base_uri 'https://api.fastspring.com'
+    format :xml
+    #debug_output
+
+    attr_reader :customer
+
+    # Get the subscription from Saasy
+    def initialize(company, reference, username, password)
+      @auth = {:username => username, :password => password}
+      @company = company
+      @reference = reference
+      @response = self.class.get(base_subscription_path, :basic_auth => @auth)
+    end
+
+    # Returns the base path for a subscription
+    def base_subscription_path
+      "/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')
+    end
+
+    # Is the subscription active?
+    def active?
+      status == 'active'
+    end
+
+    # Can the subscription be cancelled?
+    def cancelable?
+      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')
+    end
+
+    def next_period_date
+      Date.parse(value_for('nextPeriodDate'))
+    end
+
+    # The date the subscription ends on
+    def ends_on
+      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)
+    end
+
+    def renew_path
+      "#{base_subscription_path}/renew"
+    end
+
+    # Renew the subscription
+    def renew
+      self.class.post(renew_path, :basic_auth => @auth)
+    end
+
+    private
+
+    def parsed_response
+      @response.parsed_response['subscription']
+    end
+
+    def value_for(attribute)
+      parsed_response.fetch(attribute)
+    end
+
+  end
+end
+

data/spec/customer_spec.rb

@@ -0,0 +1,37 @@
+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::Customer do
+  context 'new' do
+    let(:customer_details) {
+      {
+        "firstName" => "John",
+        "lastName" => "Doe",
+        "company" => "Doe Inc",
+        "email" => "john@example.com",
+        "phoneNumber" => "0123456789"
+      }
+    }
+    subject { FastSpring::Customer.new(customer_details) }
+
+    it 'has a first name' do
+      subject.first_name.should == 'John'
+    end
+
+    it 'has a last name' do
+      subject.last_name.should == 'Doe'
+    end
+
+    it 'has a company' do
+      subject.company.should == 'Doe Inc'
+    end
+
+    it 'has a email address' do
+      subject.email.should == 'john@example.com'
+    end
+
+    it 'has a phone number' do
+      subject.phone_number.should == '0123456789'
+    end
+  end
+end

data/spec/fixtures/basic_subscription.xml

@@ -0,0 +1,25 @@
+<subscription>
+  <status>active</status>
+  <statusChanged>2010-08-15T00:00:00.000Z</statusChanged>
+  <statusReason>completed</statusReason>
+  <cancelable>true</cancelable>
+  <reference/>
+  <test>true</test>
+  <referrer>acme_app</referrer>
+  <sourceName>acme_source</sourceName>
+  <sourceKey>acme_source_key</sourceKey>
+  <sourceCampaign>acme_source_campaign</sourceCampaign>
+  <customer>
+    <firstName>John</firstName>
+    <lastName>Doe</lastName>
+    <company>Doe Inc</company>
+    <email>johndoe@example.com</email>
+    <phoneNumber>0123456789</phoneNumber>
+  </customer>
+  <customerUrl/>
+  <productName>Acme Inc Web</productName>
+  <tags/>
+  <quantity>0</quantity>
+  <nextPeriodDate>2010-08-15Z</nextPeriodDate>
+  <end>2010-08-15Z</end>
+</subscription>

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "httparty"
+
+require 'webmock/rspec'
+
+def file_fixture(filename)
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+end
+
+def stub_http_response_with(filename)
+  format = filename.split('.').last.intern
+  data = file_fixture(filename)
+
+  response = Net::HTTPOK.new("1.1", 200, "Content for you")
+  response.stub!(:body).and_return(data)
+
+  http_request = HTTParty::Request.new(Net::HTTP::Get, 'http://localhost', :format => format)
+  http_request.stub_chain(:http, :request).and_return(response)
+
+  HTTParty::Request.should_receive(:new).and_return(http_request)
+end
+
+def stub_response(body, code = 200)
+  @request.options[:base_uri] ||= 'http://localhost'
+  unless defined?(@http) && @http
+    @http = Net::HTTP.new('localhost', 80)
+    @request.stub!(:http).and_return(@http)
+  end
+
+  response = Net::HTTPResponse::CODE_TO_OBJ[code.to_s].new("1.1", code, body)
+  response.stub!(:body).and_return(body)
+
+  @http.stub!(:request).and_return(response)
+  response
+end

data/spec/subscription_spec.rb

@@ -0,0 +1,92 @@
+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::Subscription do
+  context 'url for subscriptions' do
+    subject { FastSpring::Subscription.new('acme', 'test_ref', 'admin', 'test') }
+    before do
+      stub_request(:get, "https://admin:test@api.fastspring.com/company/acme/subscription/test_ref").
+        to_return(:status => 200, :body => "", :headers => {})
+    end
+
+    it 'returns the path for the company and reference' do
+      subject.base_subscription_path.should == "/company/acme/subscription/test_ref"
+    end
+  end
+
+  context 'subscription details' do
+    subject { FastSpring::Subscription.new('acme', 'test_ref', 'admin', 'test') }
+    let(:customer) { mock(:customer) }
+    before do
+      stub_request(:get, "https://admin:test@api.fastspring.com/company/acme/subscription/test_ref").
+        to_return(stub_http_response_with('basic_subscription.xml'))
+      FastSpring::Customer.stub(:new => customer)
+    end
+
+    context 'when active' do
+      it 'returns the status' do
+        subject.status.should == 'active'
+      end
+
+      it 'returns the status changed date' do
+        subject.status_changed.should be_an_instance_of(DateTime)
+      end
+
+      it 'returns the reason for status change' do
+        subject.status_reason.should == 'completed'
+      end
+
+      it 'is active' do
+        subject.should be_active
+      end
+    end
+
+    it 'returns the cancelable state' do
+      subject.should be_cancelable
+    end
+
+    it 'returns the referrer' do
+      subject.referrer.should == 'acme_app'
+    end
+
+    it 'returns the source name' do
+      subject.source_name.should == 'acme_source'
+    end
+
+    it 'returns the source key' do
+      subject.source_key.should == 'acme_source_key'
+    end
+
+    it 'returns the source campaign' do
+      subject.source_campaign.should == 'acme_source_campaign'
+    end
+
+    it 'returns a customer' do
+      subject.customer.should == customer
+    end
+
+    it 'returns the product name' do
+      subject.product_name.should == 'Acme Inc Web'
+    end
+
+    it 'returns the next period date' do
+      subject.next_period_date.should be_an_instance_of(Date)
+    end
+
+    it 'returns the end date' do
+      subject.ends_on.should be_an_instance_of(Date)
+    end
+  end
+
+  context 'renew' do
+    subject { FastSpring::Subscription.new('acme', 'test_ref', 'admin', 'test') }
+    before do
+      stub_request(:get, "https://admin:test@api.fastspring.com/company/acme/subscription/test_ref").
+        to_return(stub_http_response_with('basic_subscription.xml'))
+    end
+
+    it 'returns a renewal path' do
+      subject.renew_path.should == "/company/acme/subscription/test_ref/renew"
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: fastspring-saasy
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Richard Patching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70283465740340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70283465740340
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70283465738460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70283465738460
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70283465737120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70283465737120
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70283465735680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70283465735680
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70283465731180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: *70283465731180
+description: Ruby lib for using the FastSpring (Saas) subscription management API
+email: richard@justaddpixels.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fastspring-saasy.gemspec
+- lib/fastspring-saasy.rb
+- lib/fastspring-saasy/customer.rb
+- lib/fastspring-saasy/error.rb
+- lib/fastspring-saasy/subscription.rb
+- spec/customer_spec.rb
+- spec/fixtures/basic_subscription.xml
+- spec/spec_helper.rb
+- spec/subscription_spec.rb
+homepage: http://github.com/patchfx/fastspring
+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: 4132004254887174814
+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: Ruby lib for using the FastSpring (Saasy) API
+test_files: []