spreedly 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-03-17
+
+* 1 major enhancement
+
+  * Initial release.
+

data/Manifest.txt

@@ -0,0 +1,66 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/spreedly.rb
+lib/spreedly/common.rb
+lib/spreedly/mock.rb
+lib/spreedly/version.rb
+test/spreedly_gem_test.rb
+test/test_site.yml
+vendor/httparty/History
+vendor/httparty/MIT-LICENSE
+vendor/httparty/Manifest
+vendor/httparty/README
+vendor/httparty/Rakefile
+vendor/httparty/bin/httparty
+vendor/httparty/cucumber.yml
+vendor/httparty/examples/aaws.rb
+vendor/httparty/examples/basic.rb
+vendor/httparty/examples/delicious.rb
+vendor/httparty/examples/google.rb
+vendor/httparty/examples/rubyurl.rb
+vendor/httparty/examples/twitter.rb
+vendor/httparty/examples/whoismyrep.rb
+vendor/httparty/features/basic_authentication.feature
+vendor/httparty/features/command_line.feature
+vendor/httparty/features/deals_with_http_error_codes.feature
+vendor/httparty/features/handles_multiple_formats.feature
+vendor/httparty/features/steps/env.rb
+vendor/httparty/features/steps/httparty_response_steps.rb
+vendor/httparty/features/steps/httparty_steps.rb
+vendor/httparty/features/steps/mongrel_helper.rb
+vendor/httparty/features/steps/remote_service_steps.rb
+vendor/httparty/features/supports_redirection.feature
+vendor/httparty/httparty.gemspec
+vendor/httparty/lib/core_extensions.rb
+vendor/httparty/lib/httparty.rb
+vendor/httparty/lib/httparty/cookie_hash.rb
+vendor/httparty/lib/httparty/exceptions.rb
+vendor/httparty/lib/httparty/logging.rb
+vendor/httparty/lib/httparty/module_inheritable_attributes.rb
+vendor/httparty/lib/httparty/parsers.rb
+vendor/httparty/lib/httparty/parsers/json.rb
+vendor/httparty/lib/httparty/parsers/xml.rb
+vendor/httparty/lib/httparty/request.rb
+vendor/httparty/lib/httparty/response.rb
+vendor/httparty/lib/httparty/version.rb
+vendor/httparty/setup.rb
+vendor/httparty/spec/fixtures/delicious.xml
+vendor/httparty/spec/fixtures/empty.xml
+vendor/httparty/spec/fixtures/google.html
+vendor/httparty/spec/fixtures/twitter.json
+vendor/httparty/spec/fixtures/twitter.xml
+vendor/httparty/spec/fixtures/undefined_method_add_node_for_nil.xml
+vendor/httparty/spec/hash_spec.rb
+vendor/httparty/spec/httparty/cookie_hash_spec.rb
+vendor/httparty/spec/httparty/parsers/json_spec.rb
+vendor/httparty/spec/httparty/parsers/xml_spec.rb
+vendor/httparty/spec/httparty/request_spec.rb
+vendor/httparty/spec/httparty/response_spec.rb
+vendor/httparty/spec/httparty_spec.rb
+vendor/httparty/spec/spec.opts
+vendor/httparty/spec/spec_helper.rb
+vendor/httparty/spec/string_spec.rb
+vendor/httparty/website/css/common.css
+vendor/httparty/website/index.html

data/README.txt

@@ -0,0 +1,68 @@
+= Spreedly-Gem
+
+* http://terralien.com/static/projects/spreedly-gem/
+* http://github.com/terralien/spreedly-gem
+
+== DESCRIPTION:
+
+The Spreedly gem provides a convenient Ruby wrapper for the goodness that is
+the http://spreedly.com API. Created by Terralien[http://terralien.com].
+
+== FEATURES:
+
+* Makes it easy to get started.
+* Fully tested.
+* (Mostly) fully substitutable mock implementation for fast tests.
+* Great example code.
+
+== SYNOPSIS:
+
+  # For real
+  require 'spreedly'  
+  Spreedly.configure('site name', 'crazy hash token')
+  url = Spreedly.subscribe_url(:id => 'customer id', :plan => 'plan id')
+  subscriber = Spreedly::Subscriber.find('customer id')
+  subscriber.active?
+  
+  # For mock
+  require 'spreedly/mock'
+  Spreedly.configure('site name', 'crazy hash token')
+  url = Spreedly.subscribe_url(:id => 'customer id', :plan => 'plan id')
+  subscriber = Spreedly::Subscriber.find('customer id')
+  subscriber.active?
+  
+Yup, they're exactly the same except for the require and the speed!
+
+== REQUIREMENTS:
+
+* A (free) Spreedly account.
+* HTTParty (vendored for now).
+
+== INSTALL:
+
+  `sudo gem install spreedly-gem`
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Nathaniel Talbott
+
+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/Rakefile

@@ -0,0 +1,72 @@
+require 'hoe'
+require './lib/spreedly/version.rb'
+
+ENV["COPYFILE_DISABLE"] = "true" # Lose all the fugly ._ files when tar'ing
+
+hoe = nil
+Hoe.new('spreedly', Spreedly::VERSION) do |project|
+  hoe = project
+  project.rubyforge_name = 'terralien'
+  project.developer('Nathaniel Talbott', 'nathaniel@terralien.com')
+  project.test_globs = ["test/**/*_test.rb"]
+  project.extra_dev_deps = ["thoughtbot-shoulda"]
+end
+
+def remove_task(*task_names)
+  task_names.each do |task_name|
+    Rake.application.instance_eval{@tasks.delete(task_name.to_s)}
+  end
+end
+ 
+def replace_task(task_name, *args, &block)
+  name = (task_name.is_a?(Hash) ? task_name.keys.first : task_name)
+  remove_task(name)
+  task(task_name, *args, &block)
+end
+
+remove_task :docs, 'doc/index.html'
+Rake::RDocTask.new(:docs) do |rd|
+  rd.main = hoe.readme_file
+  rd.rdoc_dir = 'doc'
+
+  rd.rdoc_files += ['lib/spreedly.rb', 'lib/spreedly/common.rb', hoe.readme_file]
+
+  title = "Terralien's Spreedly Gem (#{hoe.version}) Documentation"
+
+  rd.options << "-t" << title << "-f" << "darkfish"
+end
+
+replace_task :publish_docs => [:clean, :docs] do
+  host = "terralien@terralien.biz"
+
+  remote_dir = "/var/www/terralien/www/shared/static/projects/spreedly-gem"
+  local_dir = 'doc'
+
+  sh %{rsync #{hoe.rsync_args} #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc "Run tests with and without mocking."
+replace_task :test do
+  hoe.run_tests
+
+  ENV["SPREEDLY_TEST"] = "REAL"
+  hoe.run_tests
+end
+
+desc "Run only mock tests."
+task :test_mock do
+  hoe.run_tests
+end
+
+desc "Run only real tests."
+task :test_real do
+  ENV["SPREEDLY_TEST"] = "REAL"
+  hoe.run_tests
+end
+
+desc "Run both sets of tests under multiruby"
+replace_task :multi do
+  hoe.run_tests(true)
+  ENV["SPREEDLY_TEST"] = "REAL"
+  hoe.run_tests(true)
+end

data/lib/spreedly.rb

@@ -0,0 +1,154 @@
+require 'spreedly/common'
+require 'httparty'
+
+raise "Mock Spreedly already required!" if defined?(Spreedly::MOCK)
+
+=begin rdoc
+Provides a convenient wrapper around the http://spreedly.com API.
+Instead of mucking around with http you can just Spreedly.configure
+and Spreedly::Subscriber.find. Much of the functionality is hung off
+of the Spreedly::Subscriber class, and there's also a
+Spreedly::SubscriptionPlan class.
+
+One of the goals of this wrapper is to keep your tests fast while
+also keeping your app working. It does this by providing a drop-in
+replacement for the real Spreedly functionality that skips the
+network and gives you a simple (some might call it stupid)
+implementation that will work for 90% of your tests. At least we
+hope so.
+
+Help us make the mock work better by telling us when it doesn't work
+so we can improve it. Thanks!
+
+==Example mock usage:
+
+  if ENV["SPREEDLY"] == "REAL"
+    require 'spreedly'
+  else
+    require 'spreedly/mock'
+  end
+=end
+
+module Spreedly
+  REAL = "real" # :nodoc:
+
+  include HTTParty
+  headers 'Accept' => 'text/xml'
+  headers 'Content-Type' => 'text/xml'
+  format :xml
+
+  # Call this before you start using the API to set things up.
+  def self.configure(site_name, token)
+    base_uri "https://spreedly.com/api/v4/#{site_name}"
+    basic_auth token, 'X'
+    @site_name = site_name
+  end
+  
+  def self.site_name # :nodoc:
+    @site_name
+  end
+  
+  def self.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
+  
+  class Resource # :nodoc: all
+    def initialize(data)
+      @data = data
+    end
+    
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /\?$/
+        send(method.to_s[0..-2])
+      elsif @data.include?(method.to_s)
+        @data[method.to_s]
+      else
+        super
+      end
+    end
+  end
+
+  class Subscriber < Resource
+
+    # This will DELETE all the subscribers from the site.
+    #
+    # Only works for tests sites (enforced on the Spreedly side).
+    def self.wipe!
+      Spreedly.delete('/subscribers.xml')
+    end
+
+    # Creates a new subscriber on Spreedly. The subscriber will NOT
+    # be active - they have to pay or you have to comp them for that
+    # to happen.
+    def self.create!(id, email=nil, screen_name=nil)
+      result = Spreedly.post('/subscribers.xml', :body => 
+        Spreedly.to_xml_params(:subscriber => {:customer_id => id, :email => email, :screen_name => screen_name}))
+      case result.code
+      when /2../
+        new(result['subscriber'])
+      when '403'
+        raise "Could not create subscriber: no id passed OR already exists."
+      else
+        raise "Could not create subscriber: result code #{result.code}."
+      end
+    end
+    
+    # Looks a subscriber up by id.
+    def self.find(id)
+      new(Spreedly.get("/subscribers/#{id}.xml")['subscriber'])
+    end
+    
+    # Returns all the subscribers in your site.
+    def self.all
+      Spreedly.get('/subscribers.xml')['subscribers'].collect{|data| new(data)}
+    end
+    
+    # Spreedly calls your id for the user the "customer id". This
+    # gives you a handy alias so you can just call it "id".
+    def id
+      customer_id
+    end
+    
+    # Allows you to give a complimentary subscription (if the
+    # subscriber is inactive) or a complimentary time extension (if
+    # the subscriber is inactive). Automatically figures out which
+    # to do.
+    #
+    # Note: units must be one of "days" or "months" (Spreedly
+    # enforced).
+    def comp(quantity, units, feature_level=nil)
+      params = {:duration_quantity => quantity, :duration_units => units}
+      params[:feature_level] = feature_level if feature_level
+      endpoint = (active? ? "complimentary_time_extensions" : "complimentary_subscriptions")
+      result = Spreedly.post("/subscribers/#{id}/#{endpoint}.xml", :body => Spreedly.to_xml_params(endpoint[0..-2] => params))
+      case result.code
+      when /2../
+      when '404'
+        raise "Could not comp subscriber: no longer exists."
+      when '422'
+        raise "Could not comp subscriber: validation failed."
+      when '403'
+        raise "Could not comp subscriber: invalid comp type (#{endpoint})."
+      else
+        raise "Could not comp subscriber: result code #{result.code}."
+      end
+    end
+  end
+  
+  class SubscriptionPlan < Resource
+    # Returns all of the subscription plans defined in your site.
+    def self.all
+      Spreedly.get('/subscription_plans.xml')['subscription_plans'].collect{|data| new(data)}
+    end
+  end
+end

data/lib/spreedly/common.rb

@@ -0,0 +1,24 @@
+Dir[File.dirname(__FILE__) + '/../../vendor/*'].each do |directory|
+  next unless File.directory?(directory)
+  $LOAD_PATH.unshift File.expand_path(directory + '/lib')
+end
+
+require 'uri'
+require 'bigdecimal'
+
+require 'spreedly/version'
+
+module Spreedly
+  # Generates a subscribe url for the given user id and plan.
+  def self.subscribe_url(id, plan, screen_name=nil)
+    screen_name = (screen_name ? URI.escape(screen_name) : "")
+    "https://spreedly.com/#{site_name}/subscribers/#{id}/subscribe/#{plan}/#{screen_name}"
+  end
+  
+  # Generates an edit subscriber for the given subscriber token. The
+  # token is returned with the subscriber info (i.e. by
+  # Subscriber.find).
+  def self.edit_subscriber_url(token)
+    "https://spreedly.com/#{site_name}/subscriber_accounts/#{token}"
+  end
+end

data/lib/spreedly/mock.rb

@@ -0,0 +1,113 @@
+require 'spreedly/common'
+
+raise "Real Spreedly already required!" if defined?(Spreedly::REAL)
+
+module Spreedly
+  MOCK = "mock"
+  
+  def self.configure(name, token)
+    @site_name = name
+  end
+  
+  def self.site_name
+    @site_name
+  end
+  
+  class Resource
+    def self.attributes
+      @attributes ||= {}
+    end
+
+    def self.attributes=(value)
+      @attributes = value
+    end
+    
+    def initialize(params={})
+      @attributes = params
+      self.class.attributes.each{|k,v| @attributes[k] = v.call}
+    end
+    
+    def id
+      @attributes[:id]
+    end
+
+    def method_missing(method, *args)
+      if method.to_s =~ /\?$/
+        send(method.to_s[0..-2], *args)
+      elsif @attributes.include?(method)
+        @attributes[method]
+      else
+        super
+      end
+    end
+  end
+  
+  class Subscriber < Resource
+    self.attributes = {
+      :created_at => proc{Time.now},
+      :token => proc{(rand * 1000).round},
+      :active => proc{false},
+      :store_credit => proc{BigDecimal("0.0")},
+      :active_until => proc{nil},
+      :feature_level => proc{""},
+    }
+
+    def self.wipe! # :nodoc: all
+      @subscribers = nil
+    end
+    
+    def self.create!(id, email=nil, screen_name=nil) # :nodoc: all
+      sub = new({:id => id, :email => email, :screen_name => screen_name})
+
+      if subscribers[sub.id]
+        raise "Could not create subscriber: already exists."
+      end
+
+      subscribers[sub.id] = sub
+      sub
+    end
+    
+    def self.find(id)
+      subscribers[id]
+    end
+    
+    def self.subscribers
+      @subscribers ||= {}
+    end
+    
+    def self.all
+      @subscribers.values
+    end
+    
+    def initialize(params={})
+      super
+      if !id || id == ''
+        raise "Could not create subscriber: no id passed OR already exists."
+      end
+    end
+    
+    def comp(quantity, units, feature_level=nil)
+      raise "Could not comp subscriber: no longer exists." unless self.class.find(id)
+      raise "Could not comp subscriber: validation failed." unless units && quantity
+      current_active_until = (active_until || Time.now)
+      @attributes[:active_until] = case units
+      when 'days'
+        current_active_until + (quantity.to_i * 86400)
+      when 'months'
+        current_active_until + (quantity.to_i * 30 * 86400)
+      end
+      @attributes[:feature_level] = feature_level if feature_level
+      @attributes[:active] = true
+    end
+  end
+  
+  class SubscriptionPlan < Resource
+    def self.all
+      plans.values
+    end
+    
+    def self.plans
+      @plans ||= {1 => new(:id => 1, :name => 'Default mock plan')}
+    end
+  end
+end