rspreedly 0.1.11 → 0.1.14

data/Rakefile

@@ -1,48 +1,80 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "rspreedly"
-    gem.summary = %Q{Ruby library for the Spreedly API}
-    gem.email = "richard@livsey.org"
-    gem.homepage = "http://github.com/rlivsey/rspreedly"
-    gem.authors = ["Richard Livsey"]
-    # 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 "rubygems"
+require "rubygems/package_task"
+require "rdoc/task"
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require "rspec"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format documentation --colour)
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+
+task :default => ["spec"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "rspreedly"
+  s.version           = "0.1.14"
+  s.summary           = "Ruby library for the Spreedly API"
+  s.author            = "Richard Livsey"
+  s.email             = "richard@livsey.org"
+  s.homepage          = "http://github.com/rlivsey/rspreedly"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.rdoc)
+  s.rdoc_options      = %w(--main README.rdoc)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(LICENSE Rakefile README.rdoc rspreedly.gemspec) + Dir.glob("{spec,lib}/**/*")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  s.add_dependency("httparty", ">= 0.5.0")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("webmock")
 end
 
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more
+# about that here: http://gemcutter.org/pages/gem_docs
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
 
-task :default => :spec
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
+task :package => :gemspec
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "RSpreedly #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+# Generate documentation
+RDoc::Task.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
 end
 
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/rspreedly.rb

@@ -4,6 +4,7 @@ require 'httparty'
 require 'rspreedly/error'
 require 'rspreedly/config'
 require 'rspreedly/base'
+require 'rspreedly/credit'
 require 'rspreedly/invoice'
 require 'rspreedly/line_item'
 require 'rspreedly/subscriber'
@@ -12,6 +13,7 @@ require 'rspreedly/payment_method'
 require 'rspreedly/complimentary_subscription'
 require 'rspreedly/complimentary_time_extension'
 require 'rspreedly/lifetime_complimentary_subscription'
+require 'rspreedly/transaction'
 
 module RSpreedly
 

data/lib/rspreedly/base.rb

@@ -8,8 +8,8 @@ module RSpreedly
     attr_reader :errors
 
     def self.api_request(type, path, options={})
-      site_name = RSpreedly::Config.site_name.class == Array ? RSpreedly::Config.site_name.first : RSpreedly::Config.site_name
-      api_key = RSpreedly::Config.api_key.class == Array ?  RSpreedly::Config.api_key.first : RSpreedly::Config.api_key
+      site_name = RSpreedly::Config.site_name
+      api_key = RSpreedly::Config.api_key
       path = "/#{site_name}#{path}"
 
       options.merge!({

data/lib/rspreedly/config.rb

@@ -1,26 +1,26 @@
 require 'pp'
 module RSpreedly
-  module Config    
+  module Config
     class << self
-      
+
       # the configuration hash itself
       def configuration
         @configuration ||= defaults
       end
-      
+
       def defaults
         {
           :logger     => defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : Logger.new(STDOUT),
           :debug      => false,
           :site_name  => "your-site-name",
-          :api_key    => "your-api-key"   
+          :api_key    => "your-api-key"
         }
       end
-      
+
       def [](key)
         configuration[key]
       end
-      
+
       def []=(key, val)
         configuration[key] = val
       end
@@ -29,57 +29,58 @@ module RSpreedly
       def delete(key)
         configuration.delete(key)
       end
-      
+
       # Return the value of the key, or the default if doesn't exist
-      # 
+      #
       # ==== Examples
-      # 
+      #
       # RSpreedly::Config.fetch(:monkey, false)
       # => false
-      # 
+      #
       def fetch(key, default)
         configuration.fetch(key, default)
       end
 
       def to_hash
         configuration
-      end      
+      end
 
       # Yields the configuration.
-      # 
+      #
       # ==== Examples
       #   RSpreedly::Config.use do |config|
       #     config[:debug]    = true
       #     config.something  = false
       #   end
-      # 
+      #
       def setup
         yield self
         nil
-      end      
+      end
 
       def clear
         @configuration = {}
       end
-      
+
       def reset
         @configuration = defaults
       end
-      
+
       # allow getting and setting properties via RSpreedly::Config.xxx
-      # 
+      #
       # ==== Examples
       # RSpreedly::Config.debug
       # RSpreedly::Config.debug = false
-      # 
+      #
       def method_missing(method, *args)
         if method.to_s[-1,1] == '='
-          configuration[method.to_s.tr('=','').to_sym] = *args
+          # splat with 1 item is just the item in 1.8, but an array in 1.9
+          configuration[method.to_s.tr('=','').to_sym] = args.is_a?(Array) ? args.first : args
         else
           configuration[method]
         end
-      end      
-      
-    end 
+      end
+
+    end
   end
 end

data/lib/rspreedly/credit.rb

@@ -0,0 +1,5 @@
+module RSpreedly
+  class Credit < Base
+    attr_accessor :amount
+  end
+end

data/lib/rspreedly/payment_method.rb

@@ -6,5 +6,10 @@ module RSpreedly
                     :address1, :address2, :city, :state, :zip, :country,
                     :phone_number
     end
+    class OnFile < Base
+       def to_xml(opts=nil)
+         "<payment> <account-type>on-file</account-type> </payment>"
+       end
+    end
   end
 end

data/lib/rspreedly/subscriber.rb

@@ -19,6 +19,7 @@ module RSpreedly
                   :on_trial,
                   :payment_method,
                   :ready_to_renew,
+                  :ready_to_renew_since,
                   :recurring,
                   :screen_name,
                   :store_credit,
@@ -130,7 +131,16 @@ module RSpreedly
     def comp_time_extension(extension)
       result = api_request(:post, "/subscribers/#{self.customer_id}/complimentary_time_extensions.xml", :body => extension.to_xml)
       self.attributes = result["subscriber"]
-      true      
+      true
+    end
+
+    # Give a subscriber a credit (or reduce credit by supplying a negative value (more)
+    # POST /api/v4[short site name]/subscribers/[subscriber id]/credit.xml
+    def credit(amount)
+      credit = Credit.new(:amount => amount)
+      result = api_request(:post, "/subscribers/#{self.customer_id}/credit.xml", :body => credit.to_xml)
+      self.store_credit = (self.store_credit || 0) + amount
+      true
     end
 
     # Programatically Stopping Auto Renew of a Subscriber (more)
@@ -172,7 +182,7 @@ module RSpreedly
         :grace_until,  :in_grace_period,            :lifetime_subscription, 
         :on_trial,     :ready_to_renew,             :recurring, 
         :store_credit, :store_credit_currency_code, :subscription_plan_name,   
-        :token,        :updated_at
+        :token,        :updated_at,                 :ready_to_renew_since
       ]
       
       opts[:exclude] ||= []

data/lib/rspreedly/subscription_plan.rb

@@ -26,7 +26,7 @@ module RSpreedly
     # there's no API method for just getting one plan, so we fake it!
     def self.find(id)
       return all if id == :all
-      all.find{|plan| plan.id == id}
+      all.find{|plan| plan.id == id.to_i}
     end
     
     # Get a list of all subscription plans (more)
@@ -36,5 +36,12 @@ module RSpreedly
       return [] unless response.has_key?("subscription_plans")
       response["subscription_plans"].collect{|data| SubscriptionPlan.new(data)}
     end
+    
+    # Get a list of all active subscription plans (more)
+    # GET /api/v4/[short site name]/subscription_plans.xml
+    def self.active
+      all.reject { |plan| !plan.enabled }
+    end
+    
   end
-end
+end

data/lib/rspreedly/transaction.rb

@@ -0,0 +1,39 @@
+module RSpreedly
+
+  class Transaction < Base
+
+    attr_accessor :active,
+                  :amount,
+                  :created_at,
+                  :currency_code,
+                  :description,
+                  :detail_type,
+                  :expires,
+                  :id,
+                  :invoice_id,
+                  :start_time,
+                  :terms,
+                  :updated_at,
+                  :price,
+                  :subscriber_customer_id,
+                  :detail
+
+    class << self
+
+      # Get a list of 50 transactions
+      # Passing :since => id will get the 50 transactions since that one
+      # GET /api/v4/[short site name]/transactions.xml
+      def all(opts={})
+        query_opts = {}
+        if opts[:since]
+          query_opts[:query] = {:since_id => opts[:since]}
+        end
+
+        response = api_request(:get, "/transactions.xml", query_opts)
+        return [] unless response.has_key?("transactions")
+        response["transactions"].collect{|data| Transaction.new(data)}
+      end
+
+    end
+  end
+end

data/rspreedly.gemspec

@@ -1,101 +1,36 @@
-# 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{rspreedly}
-  s.version = "0.1.11"
+  s.version = "0.1.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Livsey"]
-  s.date = %q{2010-01-20}
+  s.date = %q{2011-07-21}
   s.email = %q{richard@livsey.org}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/rspreedly.rb",
-     "lib/rspreedly/base.rb",
-     "lib/rspreedly/complimentary_subscription.rb",
-     "lib/rspreedly/complimentary_time_extension.rb",
-     "lib/rspreedly/config.rb",
-     "lib/rspreedly/error.rb",
-     "lib/rspreedly/invoice.rb",
-     "lib/rspreedly/lifetime_complimentary_subscription.rb",
-     "lib/rspreedly/line_item.rb",
-     "lib/rspreedly/payment_method.rb",
-     "lib/rspreedly/subscriber.rb",
-     "lib/rspreedly/subscription_plan.rb",
-     "rspreedly.gemspec",
-     "spec/base_spec.rb",
-     "spec/config_spec.rb",
-     "spec/fixtures/complimentary_failed_active.xml",
-     "spec/fixtures/complimentary_failed_inactive.xml",
-     "spec/fixtures/complimentary_not_valid.xml",
-     "spec/fixtures/complimentary_success.xml",
-     "spec/fixtures/create_subscriber.xml",
-     "spec/fixtures/error.xml",
-     "spec/fixtures/error_string.txt",
-     "spec/fixtures/errors.xml",
-     "spec/fixtures/existing_subscriber.xml",
-     "spec/fixtures/feature_level_blank.xml",
-     "spec/fixtures/free_plan_not_elligable.xml",
-     "spec/fixtures/free_plan_not_free.xml",
-     "spec/fixtures/free_plan_not_set.xml",
-     "spec/fixtures/free_plan_success.xml",
-     "spec/fixtures/invalid_subscriber.xml",
-     "spec/fixtures/invalid_update.xml",
-     "spec/fixtures/invoice_created.xml",
-     "spec/fixtures/invoice_invalid.xml",
-     "spec/fixtures/lifetime_subscription_success.xml",
-     "spec/fixtures/no_plans.xml",
-     "spec/fixtures/no_subscribers.xml",
-     "spec/fixtures/payment_already_paid.xml",
-     "spec/fixtures/payment_invalid.xml",
-     "spec/fixtures/payment_not_found.xml",
-     "spec/fixtures/payment_success.xml",
-     "spec/fixtures/plan_disabled.xml",
-     "spec/fixtures/plan_not_found.xml",
-     "spec/fixtures/subscriber.xml",
-     "spec/fixtures/subscriber_not_found.xml",
-     "spec/fixtures/subscribers.xml",
-     "spec/fixtures/subscription_plan_list.xml",
-     "spec/invoice_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/subscriber_spec.rb",
-     "spec/subscription_plan_spec.rb"
-  ]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["LICENSE", "Rakefile", "README.rdoc", "rspreedly.gemspec", "spec/base_spec.rb", "spec/config_spec.rb", "spec/fixtures", "spec/fixtures/complimentary_failed_active.xml", "spec/fixtures/complimentary_failed_inactive.xml", "spec/fixtures/complimentary_not_valid.xml", "spec/fixtures/complimentary_success.xml", "spec/fixtures/create_subscriber.xml", "spec/fixtures/credit_not_valid.xml", "spec/fixtures/credit_success.xml", "spec/fixtures/error.xml", "spec/fixtures/error_string.txt", "spec/fixtures/errors.xml", "spec/fixtures/existing_subscriber.xml", "spec/fixtures/feature_level_blank.xml", "spec/fixtures/free_plan_not_elligable.xml", "spec/fixtures/free_plan_not_free.xml", "spec/fixtures/free_plan_not_set.xml", "spec/fixtures/free_plan_success.xml", "spec/fixtures/invalid_subscriber.xml", "spec/fixtures/invalid_update.xml", "spec/fixtures/invoice_created.xml", "spec/fixtures/invoice_invalid.xml", "spec/fixtures/lifetime_subscription_success.xml", "spec/fixtures/no_plans.xml", "spec/fixtures/no_subscribers.xml", "spec/fixtures/no_transactions.xml", "spec/fixtures/payment_already_paid.xml", "spec/fixtures/payment_invalid.xml", "spec/fixtures/payment_not_found.xml", "spec/fixtures/payment_success.xml", "spec/fixtures/plan_disabled.xml", "spec/fixtures/plan_not_found.xml", "spec/fixtures/subscriber.xml", "spec/fixtures/subscriber_not_found.xml", "spec/fixtures/subscribers.xml", "spec/fixtures/subscription_plan_list.xml", "spec/fixtures/transactions.xml", "spec/invoice_spec.rb", "spec/spec_helper.rb", "spec/subscriber_spec.rb", "spec/subscription_plan_spec.rb", "spec/transaction_spec.rb", "lib/rspreedly", "lib/rspreedly/base.rb", "lib/rspreedly/complimentary_subscription.rb", "lib/rspreedly/complimentary_time_extension.rb", "lib/rspreedly/config.rb", "lib/rspreedly/credit.rb", "lib/rspreedly/error.rb", "lib/rspreedly/invoice.rb", "lib/rspreedly/lifetime_complimentary_subscription.rb", "lib/rspreedly/line_item.rb", "lib/rspreedly/payment_method.rb", "lib/rspreedly/subscriber.rb", "lib/rspreedly/subscription_plan.rb", "lib/rspreedly/transaction.rb", "lib/rspreedly.rb"]
   s.homepage = %q{http://github.com/rlivsey/rspreedly}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Ruby library for the Spreedly API}
-  s.test_files = [
-    "spec/base_spec.rb",
-     "spec/config_spec.rb",
-     "spec/invoice_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/subscriber_spec.rb",
-     "spec/subscription_plan_spec.rb"
-  ]
-  s.add_dependency('httparty', '>= 0.5.0')
 
   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
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
     else
+      s.add_dependency(%q<httparty>, [">= 0.5.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
     end
   else
+    s.add_dependency(%q<httparty>, [">= 0.5.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
   end
 end
-