recurly 0.4.11 → 0.4.13

data/README.md

@@ -16,7 +16,7 @@ Installation
 
 **Stable Version:**
 
-    gem 'recurly'
+    gem 'recurly', '~> 0.4.11'
 
 **Bleeding Edge Version:**
 
@@ -37,10 +37,8 @@ Setup (Rails 2 and other frameworks)
 Alternatively, if not using Rails 3, just make sure to call a Recurly configure block somewhere in your applications initialization.
 
     Recurly.configure do |c|
-      c.username = 'api@yourcompany.com'
-      c.password = 'your_api_key'
+      c.api_key = 'your_api_key'
       c.private_key = 'your_private_key'
-      c.environment = :production # or :sandbox for test sites
       c.subdomain = 'your-recurly-subdomain'
     end
 
@@ -48,7 +46,7 @@ In Rails 2.x, this code should be in config/initializers/recurly.rb
 
 In Sinatra, it should be within a `configure` block.
 
-**Please Note:** the setup parameters changed in version 0.4.0. The Ruby client now connects to either api-production.recurly.com or api-sandbox.recurly.com to improve DNS lookups. Additional configuration options were also added for the [Transparent Post API](http://docs.recurly.com/transparent-post/basics).
+**Please Note:** the setup parameters changed in version 0.4.0. Additional configuration options were also added for the [Transparent Post API](http://docs.recurly.com/transparent-post/basics).
 
 Manual Setup via YAML or JSON
 --------------
@@ -58,10 +56,8 @@ You can also configure Recurly via a YAML file by using:
 
 The Recurly Configuration YAML is in the format of:
 
-    username: myrecurlyuser@domain.com
-    password: your_api_key
+    api_key: your_api_key
     private_key: your_private_key
-    environment: :production
     subdomain: your_recurly_subdomain
 
 

data/lib/recurly.rb

@@ -41,7 +41,7 @@ module Recurly
   autoload :Verification,   'recurly/verification'
 
   class << self
-    attr_accessor :username, :password, :environment, :subdomain, :private_key
+    attr_accessor :api_key, :environment, :subdomain, :private_key
 
     # default Recurly.settings_path to config/recurly.yml
     unless respond_to?(:settings_path)
@@ -55,15 +55,14 @@ module Recurly
     end
 
     def configured?
-      Base.user && Base.password && Base.site
+      Base.user && Base.site
     end
 
     def configure
       if block_given?
         yield self
 
-        Base.user = username
-        Base.password = password
+        Base.user = api_key
         Base.site = site_for_environment(environment)
 
         return true
@@ -77,22 +76,16 @@ module Recurly
     end
     
     def site_for_environment(environment)
-      environment = :production if environment.nil? # Default to production
-      case environment.to_sym
-      when :development
-        "http://app.lvh.me:3000"
-      when :production
-        "https://api-production.recurly.com"
-      when :sandbox
-        "https://api-sandbox.recurly.com"
+      if environment == :development
+        "http://api.lvh.me:3000"
       else
-        raise Recurly::ConfigurationError.new("Invalid environment (#{environment}). Valid values are: :production, :sandbox.")
+        "https://api.recurly.com"
       end
     end
 
 
     # allows configuration from a yml file that contains the fields:
-    # username,password,site,private_key
+    # api_key,site,private_key
     def configure_from_yaml(path = nil)
       configure do |c|
         # parse configuration from yml
@@ -105,8 +98,7 @@ module Recurly
           recurly_env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
           recurly_config = recurly_config[recurly_env] if recurly_config.has_key?(recurly_env)
 
-          c.username = recurly_config["username"]
-          c.password = recurly_config["password"]
+          c.api_key = recurly_config["api_key"] || recurly_config["password"]
           c.subdomain = recurly_config["subdomain"]
           c.private_key = recurly_config["private_key"]
           c.environment = recurly_config["environment"]
@@ -115,12 +107,11 @@ module Recurly
     end
 
     # allows configuration from a json string that contains the fields:
-    # username,password,site,private_key
+    # api_key,site,private_key
     def configure_from_json(json_string)
       config_data = ActiveSupport::JSON.decode(json_string)
       configure do |c|
-        c.username = config_data['username']
-        c.password = config_data['password']
+        c.api_key = config_data['api_key'] || config_data['password']
         c.subdomain = config_data['subdomain']
         c.private_key = config_data['private_key']
         c.environment = config_data['environment']

data/lib/recurly/config_parser.rb

@@ -1,4 +1,7 @@
+require 'erb'
 require 'fileutils'
+require 'yaml'
+
 module Recurly
   module ConfigParser
     class << self
@@ -7,7 +10,7 @@ module Recurly
         path ||= Recurly.settings_path
         settings = {}
         if File.exists?(path)
-          settings = YAML.load_file(path) || {}
+          settings = YAML::load(ERB.new(File.read(path)).result) || {}
         else
           puts "\n#{path} file not found. Run rake recurly:setup to create one\n\n"
         end
@@ -25,4 +28,4 @@ module Recurly
     end
   end
 
-end
+end

data/lib/recurly/plan.rb

@@ -1,7 +1,6 @@
 module Recurly
   class Plan < Base
     self.element_name = "plan"
-    self.prefix = "/site/"
     self.primary_key = :plan_code
 
     def self.known_attributes

data/lib/recurly/rails3/recurly.rake

@@ -6,7 +6,7 @@ namespace :recurly do
     @recurly_config = Recurly::ConfigParser.parse
   end
 
-  desc "Clears out the Test data from your configured Recurly site (does not touch your production site)"
+  desc "Clears out the Test data from your configured Recurly site (does not touch your data in production mode)"
   task :clear_test_data => :load_settings do
     puts "\n"
 
@@ -17,42 +17,26 @@ namespace :recurly do
       exit
     end
 
-    username = @recurly_config["username"]
-    password = @recurly_config["password"]
-
-    # lets try logging into site
-    login_response = nil
-    begin
-      RestClient.post "https://app.recurly.com/login",
-        :user_session => {
-          :email => username,
-          :password => password
-        }
-
-      # yes, RestClient api is weird
-      raise "Login Failed for #{username} (we should have gotten a redirect)"
-    rescue RestClient::Found => e
-      # we got a redirect. horray!
-      login_response = e.response
-    end
+    api_key = @recurly_config["api_key"]
+    environment = @recurly_config["environment"]
 
     # now lets clear site data
     begin
-      RestClient.post( @recurly_config["site"]+"/site/test_data",
-                       {"_method"=>"delete"},
-                       :cookies => login_response.cookies)
+      if environment == :development
+        RestClient.delete("http://#{api_key}@api.lvh.me:3000/configuration/test_data")
+      else
+        RestClient.delete("https://#{api_key}@api.recurly.com/configuration/test_data")
+      end
       raise "Clearing Didn't work for some reason. Is your site setting correct?"
     rescue RestClient::Found => e
-      puts "Test Data Cleared from: #{@recurly_config["site"]}"
+      puts "Test Data Cleared"
     end
   end
 
   def setup_static
-    @recurly_config["username"] ||= "myemail@mydomain.com"
-    @recurly_config["password"] ||= "my_api_key"
+    @recurly_config["api_key"] ||= "my_api_key"
     @recurly_config["private_key"] ||= "my_private_key"
     @recurly_config["subdomain"] ||= "mysite"
-    @recurly_config["site"] ||= "https://api-production.recurly.com"
   end
 
   desc "Creates a recurly.yml config file"

data/lib/recurly/transparent.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module Recurly
 
   module Action

data/lib/recurly/verification.rb

@@ -1,5 +1,10 @@
 module Recurly
   module Verification
+
+    def stringify_keys data
+      Hash[data.map { |k, v| [k.to_s, v] }]
+    end
+
     class PreEscapedString < String
     end
 
@@ -8,7 +13,8 @@ module Recurly
         return nil if data.empty?
         PreEscapedString.new( '[%s]' % data.map{|v|digest_data(v)}.compact.join(',') )
       elsif data.is_a? Hash
-        digest_data Hash[data.sort].map {|k,v|
+        data = stringify_keys data
+        digest_data data.sort.map {|k,v|
           prefix = (k =~ /\A\d+\Z/) ? '' : (k.to_s+':')
           (v=digest_data(v)).nil? ? nil : PreEscapedString.new('%s%s' % [prefix,v])
         }
@@ -35,11 +41,11 @@ module Recurly
 
     # Raises a Recurly::ForgedQueryString exception if the signature cannot be validated
     def verify_params!(claim, args)
-      args = Hash[args.map { |k, v| [k.to_s, v] }]
+      args = stringify_keys args
       signature = args.delete('signature') or raise Recurly::ForgedQueryString.new('Signature is missing')
       hmac, timestamp = signature.split('-')
       age = Time.now.to_i - timestamp.to_i
-      raise Recurly::ForgedQueryString.new('Timestamp is too old or new') if age > 3600 || age < 0
+      raise Recurly::ForgedQueryString.new('Timestamp is too old or new') if age > 3600 || age < -3600
 
       if signature != generate_signature(claim, args, timestamp)
         raise Recurly::ForgedQueryString.new('Signature cannot be verified')
@@ -48,15 +54,15 @@ module Recurly
 
     def sign_billing_info_update(account_code)
       generate_signature('billinginfoupdate', {
-        account_code: account_code
+        :account_code => account_code
       })
     end
 
-    def sign_transaction(account_code, currency, amount_in_cents)
+    def sign_transaction(amount_in_cents, currency, account_code=nil)
       generate_signature('transactioncreate', {
-        account_code: account_code,
-        currency: currency,
-        amount_in_cents: amount_in_cents
+        :account_code => account_code,
+        :currency => currency,
+        :amount_in_cents => amount_in_cents
       }) 
     end
 

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly #:nodoc
-  VERSION = "0.4.11"
+  VERSION = "0.4.13"
 end

data/spec/config/recurly.yml

@@ -1,6 +1,6 @@
 ---
-username: api-test@facebook-test.com
-password: 69d95a9768c745ecb5ac6864032ec970
+username: hello@test.com
+password: 2a655d41659d4ae0b37fcaec06331bf5
 private_key: 4cdbdfbb90f84b3c8fb4ca337d1b2cfc
-subdomain: facebook-test
+subdomain: intuit
 environment: :development

data/spec/config/test1.yml

@@ -1,6 +1,4 @@
 ---
-username: username1@recurly.com
-password: asdf4jk31
+api_key: asdf4jk31
 subdomain: site1
 private_key: asdfasdfasdf
-environment: :production

data/spec/config/test2.yml

@@ -1,11 +1,7 @@
 development:
-  username: username1@recurly.com
-  password: asdf4jk31
+  api_key: asdf4jk31
   subdomain: site1
-  environment: :sandbox
 
 test:
-  username: username2@recurly.com
-  password: asdf4jk32
+  api_key: asdf4jk32
   subdomain: site2
-  environment: :production

data/spec/unit/config_spec.rb

@@ -5,15 +5,13 @@ describe "RecurlyConfig" do
   context "loading from YML" do
     it "should load traditional configuration from a YML file" do
       Recurly.configure_from_yaml("#{File.dirname(__FILE__)}/../config/test1.yml")
-      Recurly.username.should == "username1@recurly.com"
-      Recurly.password.should == "asdf4jk31"
+      Recurly.api_key.should == "asdf4jk31"
       Recurly.subdomain.should == "site1"
     end
     
     it "should load configuration from a YML file based on running environment" do
       Recurly.configure_from_yaml("#{File.dirname(__FILE__)}/../config/test2.yml")
-      Recurly.username.should == "username2@recurly.com"
-      Recurly.password.should == "asdf4jk32"
+      Recurly.api_key.should == "asdf4jk32"
       Recurly.subdomain.should == "site2"
     end
   end
@@ -21,28 +19,23 @@ describe "RecurlyConfig" do
   context "loading from json" do
     it "should load configuration from a json config string" do
       Recurly.configure_from_json({
-        :username => "someuser@heroku.com",
-        :password => "somepass",
-        :environment => :sandbox,
+        :api_key => "somepass",
         :subdomain => 'recurlytest3-test',
       }.to_json)
-      Recurly.username.should == "someuser@heroku.com"
-      Recurly.password.should == "somepass"
+      Recurly.api_key.should == "somepass"
       Recurly.subdomain.should == 'recurlytest3-test'
-      Recurly::Base.site.to_s.should == "https://api-sandbox.recurly.com"
+      Recurly::Base.site.to_s.should == "https://api.recurly.com"
 
       # test with some crazy chars in the password
       Recurly.configure_from_json({
-        :username => "api-someuser@heroku.com",
-        :password => "*$&!!::@&!)*)*_",
+        :api_key => "*$&!!::@&!)*)*_",
         :subdomain => "recurlytest3-test",
-        :environment => :sandbox,
       }.to_json)
 
-      Recurly.username.should == "api-someuser@heroku.com"
-      Recurly.password.should == "*$&!!::@&!)*)*_"
+      Recurly.api_key.should == "*$&!!::@&!)*)*_"
+      Recurly::Base.user.should == Recurly.api_key
       Recurly.subdomain.should == 'recurlytest3-test'
-      Recurly::Base.site.to_s.should == "https://api-sandbox.recurly.com"
+      Recurly::Base.site.to_s.should == "https://api.recurly.com"
     end
 
   end

data/spec/unit/transparent_spec.rb

@@ -16,26 +16,6 @@ module Recurly
         Transparent.url(Action::UpdateBilling).should == "#{Recurly::Base.site}/transparent/#{Recurly.subdomain}/billing_info"
         Transparent.url(Action::CreateTransaction).should == "#{Recurly::Base.site}/transparent/#{Recurly.subdomain}/transaction"
       end
-
-      it "should equal api-sandbox for sandbox" do
-        Recurly.configure do |config|
-          config.environment = :sandbox
-          config.subdomain = 'testtest'
-        end
-        Transparent.url(Action::CreateSubscription).should == "#{Recurly::Base.site}/transparent/testtest/subscription"
-        Transparent.url(Action::UpdateBilling).should == "#{Recurly::Base.site}/transparent/testtest/billing_info"
-        Transparent.url(Action::CreateTransaction).should == "#{Recurly::Base.site}/transparent/testtest/transaction"
-      end
-
-      it "should equal api-production for sandbox" do
-        Recurly.configure do |config|
-          config.environment = :production
-          config.subdomain = 'testtest'
-        end
-        Transparent.url(Action::CreateSubscription).should == "#{Recurly::Base.site}/transparent/testtest/subscription"
-        Transparent.url(Action::UpdateBilling).should == "#{Recurly::Base.site}/transparent/testtest/billing_info"
-        Transparent.url(Action::CreateTransaction).should == "#{Recurly::Base.site}/transparent/testtest/transaction"
-      end
     end
 
     describe ".encrypt_string" do

data/spec/unit/verification_spec.rb

@@ -18,10 +18,16 @@ module Recurly
 
     it "should encode nested arrays and hashes" do
       Verification::digest_data( 
-        {a: [1,2,3], b: {c: '123', d:'456'}}
+        {:a => [1,2,3], :b => {:c => '123', :d => '456'}}
       ).should == '[a:[1,2,3],b:[c:123,d:456]]'
     end
 
+    it "should alphabetize keys" do
+      Verification::digest_data( 
+        {:a => 1, :c => 3, :b => 2}
+      ).should == '[a:1,b:2,c:3]'
+    end
+
     it "should treat hashes with numeric indexes as arrays" do
       Verification::digest_data( 
         {'1' => 4, '2' => 5, '3' => 6}
@@ -30,13 +36,13 @@ module Recurly
 
     it "should escape syntax characters" do
       Verification::digest_data(
-        {syntaxchars: ' \\ [ ] : , '}
+        { :syntaxchars =>  ' \\ [ ] : , '}
       ).should == '[syntaxchars: \\\\ \[ \] \: \, ]'
     end
 
     it "should generate proper signatures" do
       Time.stub!(:now).and_return(origin_time) # gen at origin time
-      sig = Verification.generate_signature('update',{a:'foo',b:'bar'})
+      sig = Verification.generate_signature('update',{ :a => 'foo', :b => 'bar'})
       sig.should == test_sig
     end
 
@@ -44,7 +50,7 @@ module Recurly
       Time.stub!(:now).and_return(Time.at(origin_time+60)) # one minute passed
       lambda {
         good = Verification.verify_params!('update',
-                           {a:'foo',b:'bar',signature:test_sig})
+                           { :a => 'foo', :b => 'bar', :signature => test_sig})
       }.should_not raise_error
     end
 
@@ -52,7 +58,7 @@ module Recurly
       Time.stub!(:now).and_return(Time.at(origin_time+60)) # one minute passed
       lambda {
         good = Verification.verify_params!('update',
-                           {a:'foo',b:'bar',signature:'badsig'})
+                           { :a => 'foo', :b => 'bar', :signature => 'badsig'})
       }.should raise_error(Recurly::ForgedQueryString)
     end
 
@@ -60,15 +66,15 @@ module Recurly
       Time.stub!(:now).and_return(Time.at(origin_time+7200)) # two hours passed
       lambda {
         good = Verification.verify_params!('update',
-                           {a:'foo',b:'bar',signature:test_sig})
+                           { :a => 'foo', :b => 'bar', :signature => test_sig})
       }.should raise_error(Recurly::ForgedQueryString)
     end
 
-    it "should reject time traveling signatures from the future" do
-      Time.stub!(:now).and_return(Time.at(origin_time-60)) # one minute earlier
+    it "should reject time traveling signatures from the future (with 1 hour grace period)" do
+      Time.stub!(:now).and_return(Time.at(origin_time-7200)) # two hours earlier
       lambda {
         good = Verification.verify_params!('update',
-                           {a:'foo',b:'bar',signature:test_sig})
+                           { :a => 'foo', :b => 'bar', :signature => test_sig})
       }.should raise_error(Recurly::ForgedQueryString)
     end
   end