erbmicha-spreedly 0.0.1

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 Michael Erb
+
+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,27 @@
+= spreedly
+
+This gem is a wrapper for the Spreedly Web Services API.
+
+== Installation
+
+gem install erbmicha-spreedly
+
+== Usage
+
+spreedly = Spreedly.new("site_name", "site_token")
+spreedly.get_subscribers
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Michael Erb. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "spreedly"
+    gem.summary = %Q{This gem is a wrapper for the Spreedly Web Services API.}
+    gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "michael@erbmicha.com"
+    gem.homepage = "http://github.com/erbmicha/spreedly"
+    gem.authors = ["Michael Erb"]
+    gem.add_development_dependency "rspec"
+    # 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']
+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 = "spreedly #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/spreedly.rb

@@ -0,0 +1,122 @@
+require 'rubygems'
+require 'httparty'
+
+require 'spreedly/error'
+require 'spreedly/invoice'
+require 'spreedly/request'
+require 'spreedly/subscriber'
+require 'spreedly/subscription_plan'
+
+class Spreedly
+
+  # include HTTParty
+  # base_uri "https://spreedly.com/api/v4"
+  # format :xml
+  # class << self; end
+      
+  def initialize(site_name, api_token)
+    @site_name = site_name
+    @auth = {:username => api_token, :password => "X"}
+  end
+  
+  def get_subscriber(subscriber_id, options={})
+    options.merge!({:basic_auth => @auth})
+    response = Spreedly::Request.new(:get, "/#{@site_name}/subscribers/#{subscriber_id}.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def get_subscribers(options={})
+    options.merge!({:basic_auth => @auth})
+    response = Spreedly::Request.new(:get, "/#{@site_name}/subscribers.xml", options)
+    response.map! { |subscriber| Spreedly::Subscriber.new(subscriber) }
+  end
+  
+  def create_subscriber(subscriber={}, options={})    
+    options.merge!({:basic_auth => @auth, :body => to_xml_params(subscriber)})
+    response = Spreedly::Request.new(:post, "/#{@site_name}/subscribers.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def update_subscriber(subscriber={}, options={})
+    options.merge!({:basic_auth => @auth, :body => to_xml_params(subscriber)})
+    response = Spreedly::Request.new(:put, "/#{@site_name}/subscribers/#{subscriber[:id]}.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def add_complimentary_subscription(subscriber_id, complimentary_subscription={}, options={})
+    options.merge!({:basic_auth => @auth, :body => to_xml_params(complimentary_subscription)})
+    response = Spreedly::Request.new(:post, "/#{@site_name}/subscribers/#{subscriber_id}/complimentary_subscriptions.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def add_complimentary_time_extension(subscriber_id, complimentary_time_extension={}, options={})
+    options.merge!({:basic_auth => @auth, :body => to_xml_params(complimentary_time_extension)})
+    response = Spreedly::Request.new(:post, "/#{@site_name}/subscribers/#{subscriber_id}/complimentary_time_extension.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def stop_auto_renew(subscriber_id, options={})
+    options.merge!({:basic_auth => @auth})
+    response = Spreedly::Request.new(:post, "/#{@site_name}/subscribers/#{subscriber_id}/stop_auto_renew.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def subscribe_to_free_trial(subscriber_id, subscription_plan={}, options={})
+    options.merge!({:basic_auth => @auth, :body => to_xml_params(subscription_plan)})
+    response = Spreedly::Request.new(:post, "/#{@site_name}/subscribers/#{subscriber_id}/subscribe_to_free_trial.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def allow_another_free_trial(subscriber_id, options={})
+    options.merge!({:basic_auth => @auth})
+    response = Spreedly::Request.new(:post, "/#{@site_name}/subscribers/#{subscriber_id}/allow_free_trial.xml", options)
+    Spreedly::Subscriber.new(response)
+  end
+  
+  def get_subscription_plans(options={})
+    options.merge!({:basic_auth => @auth})
+    response = Spreedly::Request.new(:get, "/#{@site_name}/subscription_plans.xml", options)
+    # response.map! { |subscription_plan| Spreedly::SubscriptionPlan.new(response) }
+  end
+  
+  def create_invoice(invoice={}, options={})
+    options.merge!({:basic_auth => @auth, :body => to_xml_params(invoice)})
+    response = Spreedly::Request.new(:post, "/#{@site_name}/invoices.xml", options)
+    Spreedly::Invoice.new(response)
+  end
+  
+  def pay_invoice(invoice_token, payment={}, options={})
+    options.merge!({:basic_auth => @auth, :body => to_xml_params(payment)})
+    response = Spreedly::Request.new(:get, "/#{@site_name}/invoices/#{invoice_token}/pay.xml", options)
+    Spreedly::Invoice.new(response)
+  end
+  
+  def delete_test_subscriber(subscriber_id, options={})
+    options.merge!({:basic_auth => @auth})
+    response = Spreedly::Request.new(:delete, "/#{@site_name}/subscribers/#{subscriber_id}.xml", options)
+  end
+  
+  def delete_test_subscribers(options={})
+    options.merge!({:basic_auth => @auth})
+    response = Spreedly::Request.new(:delete, "/#{@site_name}/subscribers.xml", options)
+  end
+  
+  private
+  
+  def to_xml_params(hash) # :nodoc:
+    hash.collect do |key, value|
+      tag = key.to_s.tr('_', '-')
+      result = "<#{tag}>"
+      if value.is_a?(Hash)
+        result << to_xml_params(value)
+      else
+        result << value.to_s
+      end
+      result << "</#{tag}>"
+      result
+    end.join('')
+  end
+end
+
+spreedly = Spreedly.new("mm-test", "fbc375641ec5f13bdc10c8c8ed22f0c3e4348dcc")
+spreedly.get_subscription_plans

data/lib/spreedly/error.rb

@@ -0,0 +1,7 @@
+class Spreedly
+  class SpreedlyError   < StandardError; end
+  class Forbidden       < SpreedlyError; end # 403 errors
+  class BadRequest      < SpreedlyError; end # 422 errors
+  class NotFound        < SpreedlyError; end # 404 errors
+  class GatewayTimeout  < SpreedlyError; end # 504 errors
+end

data/lib/spreedly/invoice.rb

@@ -0,0 +1,31 @@
+class Spreedly
+  class Invoice
+    attr_accessor :closed, :created_at, :token, :updated_at, :subscriber_store_credit, :price, :amount, :currency_code, :line_items, :subscriber
+    def initialize(invoice={})
+      self.closed =                   invoice["closed"]
+      self.created_at =               invoice["created_at"]
+      self.token =                    invoice["token"]
+      self.updated_at =               invoice["updated_at"]
+      self.subscriber_store_credit =  invoice["subscriber_store_credit"]
+      self.price =                    invoice["price"]
+      self.amount =                   invoice["amount"]
+      self.currency_code =            invoice["currency_code"]
+      self.line_items =               []
+      invoice["line_items"].each do |line_item|
+        self.line_items << LineItem(line_item)
+      end
+      self.subscriber =               Spreedly::Subscriber.new(invoice["subscriber"])
+    end
+    
+    class LineItem
+      attr_accessor :amount, :currency_code, :description, :price, :subscription_plan_version_id
+      def initialize(line_item={})
+        self.amount =                       line_item["amount"]
+        self.currency_code =                line_item["currency_code"]
+        self.description =                  line_item["description"]
+        self.price =                        line_item["price"]
+        self.subscription_plan_version_id = line_item["subscription_plan_version_id"]
+      end
+    end
+  end
+end

data/lib/spreedly/request.rb

@@ -0,0 +1,33 @@
+class Spreedly
+  class Request
+    include HTTParty
+    base_uri "https://spreedly.com/api/v4"
+    format :xml
+    
+    def initialize(type, path, options)
+      response = self.class.send type.to_s, path, options
+      return response unless raise_errors(response)
+    end
+    
+    def raise_errors(response)
+      if(response.is_a?(Hash))
+        message = "#{response[:status]}: #{response[:body]}"
+        code = response[:status].to_i
+      else
+        message = "#{response.status}: #{response.body}"
+        code = response.status.to_i
+      end
+      
+      case code
+        when 403
+          raise(Forbidden.new, message)
+        when 422
+          raise(BadRequest.new, message)
+        when 404
+          raise(NotFound.new, message)
+        when 201
+          return false
+      end        
+    end 
+  end
+end

data/lib/spreedly/subscriber.rb

@@ -0,0 +1,25 @@
+class Spreedly
+  class Subscriber
+    attr_accessor :active_until, :billing_first_name, :billing_last_name, :created_at, :customer_id, :eligible_for_free_trial, :email, :lifetime_subscription, :screen_name, :store_credit, :token, :updated_at, :recurring, :card_expires_before_next_auto_renew, :subscription_plan_name, :active, :on_trial, :feature_level
+    def initialize(subscriber={})
+      self.active_until =                         subscriber["active_until"]
+      self.billing_first_name =                   subscriber["billing_first_name"]
+      self.billing_last_name =                    subscriber["billing_last_name"]
+      self.created_at =                           subscriber["created_at"]
+      self.customer_id =                          subscriber["customer_id"]
+      self.eligible_for_free_trial =              subscriber["eligible_for_free_trial"]
+      self.email =                                subscriber["email"]
+      self.lifetime_subscription =                subscriber["lifetime_subscription"]
+      self.screen_name =                          subscriber["screen_name"]
+      self.store_credit =                         subscriber["store_credit"]
+      self.token =                                subscriber["token"]
+      self.updated_at =                           subscriber["updated_at"]
+      self.recurring =                            subscriber["recurring"]
+      self.card_expires_before_next_auto_renew =  subscriber["card_expires_before_next_auto_renew"]
+      self.subscription_plan_name =               subscriber["subscription_plan_name"]
+      self.active =                               subscriber["active"]
+      self.on_trial =                             subscriber["on_trial"]
+      self.feature_level =                        subscriber["feature_level"]
+    end
+  end
+end

data/lib/spreedly/subscription_plan.rb

@@ -0,0 +1,29 @@
+class Spreedly
+  class SubscriptionPlan
+    attr_accessor :force_recurring, :name, :price, :charge_after_first_period, :created_at, :charge_later_duration_units, :return_url, :updated_at, :amount, :charge_later_duration_quantity, :duration_quantity, :duration_units, :enabled, :id, :needs_to_be_renewed, :version, :plan_type, :description, :currency_code, :feature_level, :terms, :site_id
+    def initialize(subscription_plan={})
+      self.force_recurring =                subscription_plan["force_recurring"]
+      self.name =                           subscription_plan["name"]
+      self.price =                          subscription_plan["price"]
+      self.charge_after_first_period =      subscription_plan["charge_after_first_period"]
+      self.created_at =                     subscription_plan["created_at"]
+      self.charge_later_duration_units =    subscription_plan["charge_later_duration_units"]
+      self.return_url =                     subscription_plan["return_url"]
+      self.updated_at =                     subscription_plan["updated_at"]
+      self.amount =                         subscription_plan["amount"]
+      self.charge_later_duration_quantity = subscription_plan["charge_later_duration_quantity"]
+      self.duration_quantity =              subscription_plan["duration_quantity"]
+      self.duration_units =                 subscription_plan["duration_units"]
+      self.enabled =                        subscription_plan["enabled"]
+      self.id =                             subscription_plan["id"]
+      self.needs_to_be_renewed =            subscription_plan["needs_to_be_renewed"]
+      self.version =                        subscription_plan["version"]
+      self.plan_type =                      subscription_plan["plan_type"]
+      self.description =                    subscription_plan["description"]
+      self.currency_code =                  subscription_plan["currency_code"]
+      self.feature_level =                  subscription_plan["feature_level"]
+      self.terms =                          subscription_plan["terms"]
+      self.site_id =                        subscription_plan["site_id"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spreedly'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/spreedly_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Spreedly" do
+  before(:each) do
+    spreedly = Spreedly.new("mm-test", "fbc375641ec5f13bdc10c8c8ed22f0c3e4348dcc")
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: erbmicha-spreedly
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Erb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This gem is a wrapper for the Spreedly Web Services API
+email: michael@erbmicha.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/spreedly.rb
+- lib/spreedly/error.rb
+- lib/spreedly/invoice.rb
+- lib/spreedly/request.rb
+- lib/spreedly/subscriber.rb
+- lib/spreedly/subscription_plan.rb
+- spec/spec_helper.rb
+- spec/spreedly_spec.rb
+has_rdoc: true
+homepage: http://github.com/erbmicha/spreedly
+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: This gem is a wrapper for the Spreedly Web Services API.
+test_files: 
+- spec/spec_helper.rb
+- spec/spreedly_spec.rb