recurly 0.3.3 → 0.3.4

data/lib/recurly/exceptions.rb

@@ -0,0 +1,19 @@
+module Recurly
+  class RecurlyError < StandardError; end
+  
+  class ConfigurationError < RecurlyError; end
+  
+  # Query string has been tampered with and cannot be trusted.
+  class ForgedQueryString < RecurlyError; end
+
+  # Transparent Post -- validations failed or transaction failed. See the {model} for errors.
+  class ValidationsFailed < RecurlyError
+    attr_reader :model
+
+    def initialize(model)
+      @model = model
+    end
+
+  end
+  
+end

data/lib/recurly/invoice.rb

@@ -1,5 +1,5 @@
 module Recurly
-  class Invoice < RecurlyBase
+  class Invoice < Base
     self.element_name = "invoice"
     self.prefix = "/accounts/:account_code/"
 

data/lib/recurly/plan.rb

@@ -1,7 +1,19 @@
 module Recurly
-  class Plan < RecurlyBase
+  class Plan < Base
     self.element_name = "plan"
     self.prefix = "/company/"
     self.primary_key = :plan_code
+
+    def self.known_attributes
+      [
+        "plan_code",
+        "name",
+        "description",
+        "success_url",
+        "cancel_url",
+        "created_at"
+      ]
+    end
+
   end
 end

data/lib/recurly/rails3/recurly.rake

@@ -38,7 +38,7 @@ namespace :recurly do
 
     # now lets clear site data
     begin
-      RestClient.post( @recurly_config["site"]+"/site/test_data",
+      RestClient.post( Recurly::Base.site+"/site/test_data",
                        {"_method"=>"delete"},
                        :cookies => login_response.cookies)
       raise "Clearing Didn't work for some reason. Is your site setting correct?"
@@ -49,8 +49,10 @@ namespace :recurly do
 
   def setup_static
     @recurly_config["username"] ||= "myemail@mydomain.com"
-    @recurly_config["password"] ||= "mypassword"
-    @recurly_config["site"] ||= "https://my-site.recurly.com"
+    @recurly_config["password"] ||= "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/subscription.rb

@@ -1,7 +1,25 @@
 module Recurly
-  class Subscription < RecurlyAccountBase
+  class Subscription < AccountBase
     self.element_name = "subscription"
 
+    def self.known_attributes
+      [
+        "plan_code",
+        "coupon_code",
+        "unit_amount",
+        "quantity",
+        "trial_ends_at"
+      ]
+    end
+
+    # initialize associations
+    def initialize(attributes = {})
+      attributes = attributes.with_indifferent_access
+      attributes[:account] ||= {}
+      attributes[:addons] ||= []
+      super(attributes)
+    end
+
     def self.refund(account_code, refund_type = :partial)
       raise "Refund type must be :full, :partial, or :none." unless [:full, :partial, :none].include?(refund_type)
       Subscription.delete(nil, {:account_code => account_code, :refund => refund_type})
@@ -39,7 +57,7 @@ module Recurly
     # Valid timeframe: :now or :renewal
     # Valid options: plan_code, quantity, unit_amount
     def change(timeframe, options = {})
-      raise "Timeframe must be :full or :renewal." unless timeframe == 'now' or timeframe == 'renewal'
+      raise "Timeframe must be :full or :renewal." unless ['now','renewal'].include?(timeframe)
       options[:timeframe] = timeframe
       path = "/accounts/#{CGI::escape(self.subscription_account_code.to_s)}/subscription.xml"
       connection.put(path,
@@ -52,7 +70,7 @@ module Recurly
       acct_code ||= account.account_code if defined?(account) and !account.nil?
       acct_code ||= self.primary_key if defined?(self.primary_key)
       acct_code ||= self.id if defined?(self.id)
-      raise 'Missing Account Code' if acct_code.nil? or acct_code.blank?
+      raise 'Missing Account Code' if acct_code.blank?
       acct_code
     end
   end

data/lib/recurly/transaction.rb

@@ -1,7 +1,35 @@
 module Recurly
-  class Transaction < RecurlyBase
+  class Transaction < Base
     self.element_name = "transaction"
 
+    def self.known_attributes
+      [
+        "description",
+        "amount_in_cents",
+        "account_code",
+        "type",
+        "action",
+        "date",
+        "status",
+        "message",
+        "reference",
+        "ccv_result",
+        "avs_result",
+        "avs_result_street",
+        "avs_result_postal",
+        "test",
+        "voidable",
+        "refundable"
+      ]
+    end
+
+    # initialize fields with blank data
+    def initialize(attributes = {})
+      # initialize embedded attributes
+      attributes = attributes.with_indifferent_access
+      attributes[:account] ||= {}
+      super(attributes)
+    end
 
     def self.list(status = :all)
 

data/lib/recurly/transparent.rb

@@ -0,0 +1,140 @@
+module Recurly
+
+  module Action
+    CreateSubscription = "subscription"
+    UpdateBilling = "billing_info"
+    CreateTransaction = "transaction"
+  end
+
+  class Transparent
+    attr_accessor :data
+
+    def initialize(data = {})
+      @data = data || {}
+    end
+
+    # output the transparent data as a hidden field
+    def hidden_field
+      html = %{<input type="hidden" name="data" value="#{ERB::Util.html_escape(encoded_data)}" />}
+
+      if html.respond_to?(:html_safe)
+        html.html_safe
+      else
+        html
+      end
+    end
+
+    # output transparent data along with a verification string to prevent tampering of data
+    def encoded_data
+      verify_required_fields
+
+      # convert data to a query string
+      query_data = self.class.query_string(data)
+
+      # generate a validation string by encrypting the string using the private key
+      validation_string = self.class.encrypt_string(query_data)
+
+      # return the validation and query data
+      "#{validation_string}|#{query_data}"
+    end
+
+    # verify that certain fields are present (or else the transparent post wont work)
+    def verify_required_fields
+      # make sure there's a redirect_url defined
+      unless @data.has_key?(:redirect_url)
+        raise "A :redirect_url key must be defined for Transparent posts"
+      end
+      unless @data.has_key?(:account)
+        raise "An :account key must be defined for Transparent posts"
+      end
+      unless @data[:account].has_key?(:account_code)
+        raise "An :account[:account_code] key must be defined for Transparent posts"
+      end
+
+      return true
+    end
+
+    # convert data into query string
+    def self.query_string(data = {})
+      # process data
+      data = process_data(data.dup)
+      data[:time] = Time.now.utc.strftime("%d/%b/%Y %H:%M:%S %Z")
+
+      address = Addressable::URI.new
+      address.query_values = data
+      address.query
+    end
+
+    # returns the url to post to
+    def self.url(action = nil)
+      raise Recurly::ConfigurationError.new("Recurly gem not configured. run `rake recurly:setup`") unless Recurly.configured?
+      raise Recurly::ConfigurationError.new("Recurly gem not configured. 'private_key' missing.") if Recurly.private_key.blank?
+      raise Recurly::ConfigurationError.new("Recurly gem not configured. 'subdomain' missing.") if Recurly.subdomain.blank?
+
+      # default action to create new subscription
+      action ||= Action::CreateSubscription
+
+      "#{Recurly::Base.site}/transparent/#{Recurly.subdomain}/#{action}"
+    end
+
+    def self.create_subscription_url
+      url(Action::CreateSubscription)
+    end
+
+    def self.create_transaction_url
+      url(Action::CreateTransaction)
+    end
+
+    def self.update_billing_url
+      url(Action::UpdateBilling)
+    end
+
+    # returns the results via a code
+    def self.results(params)
+      # pull out the result key and status
+      type = params["type"]
+      result_key = params["result"]
+      status = params["status"]
+
+      # verify confirmation matches the passed in querystring
+      address = Addressable::URI.new
+      address.query_values = {:type => type.to_s, :status => status.to_s, :result => result_key.to_s}
+      raise Recurly::ForgedQueryString.new if params["confirm"] != encrypt_string(address.query)
+
+      # pull the class name
+      model = Recurly.const_get(type.to_s.classify)
+
+      response = nil
+      begin
+        # rebuild the ActiveResource object from the xml results
+        response = Recurly::Base.connection.get_raw("/transparent/results/#{result_key}", model.headers)
+        return model.new.from_transparent_results(response)
+
+      rescue ActiveResource::ResourceInvalid => ex
+        model_result = model.new.from_transparent_results(ex.response)
+        raise Recurly::ValidationsFailed.new(model_result)
+      end
+    end
+
+    # encode a string using the configured private key
+    def self.encrypt_string(input_string)
+      raise Recurly::ConfigurationError.new("Recurly gem not configured. To use transparent redirects, set your private_key within config/recurly.yml to the private_key provided by recurly.com") unless Recurly.private_key.present?
+      digest_key = ::Digest::SHA1.digest(Recurly.private_key)
+      sha1_hash = ::OpenSSL::Digest::Digest.new("sha1")
+      ::OpenSSL::HMAC.hexdigest(sha1_hash, digest_key, input_string.to_s)
+    end
+
+    # recursively process the query data (running to_s on values)
+    def self.process_data(data = {})
+      data.each do |key, val|
+        if val.is_a?(Hash)
+          data[key] = process_data(val)
+        elsif val.is_a?(Enumerable)
+          data[key] = val.map{|i| i.to_s}
+        else
+          data[key] = val.to_s
+        end
+      end
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly #:nodoc
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/spec/config/recurly.yml

@@ -0,0 +1,12 @@
+---
+username: api-test-123@litle.com
+password: 82a98ee0c1c2495789775177babfadb7 
+private_key: 986bfa2bec61479ca560dbaaec345820
+subdomain: litle-test
+environment: :development
+
+#username: api-test@isaactest.com
+#password: e94fb95953454b1dad4abf26af382a5d 
+#private_key: 2b656f0351e345faa1d29b2d7a455202
+#subdomain: isaachall-test
+#environment: :sandbox

data/spec/config/test1.yml

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

data/spec/config/test2.yml

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

data/spec/integration/credit_spec.rb

@@ -12,7 +12,7 @@ module Recurly
 
       before(:each) do
         credit = Factory.create_credit account.account_code,
-                                        :amount => 10.05,
+                                        :amount_in_cents => 1005,
                                         :description => "free moniez"
 
         @credit = Credit.lookup(account.account_code, credit.id)
@@ -36,9 +36,9 @@ module Recurly
       let(:account){ Factory.create_account("credit-list-#{timestamp}") }
 
       before(:each) do
-        Factory.create_credit(account.account_code, :amount => 1, :description => "one")
-        Factory.create_credit(account.account_code, :amount => 2, :description => "two")
-        Factory.create_credit(account.account_code, :amount => 3, :description => "three")
+        Factory.create_credit(account.account_code, :amount_in_cents => 100, :description => "one")
+        Factory.create_credit(account.account_code, :amount_in_cents => 200, :description => "two")
+        Factory.create_credit(account.account_code, :amount_in_cents => 300, :description => "three")
         @credits = Credit.list(account.account_code)
       end
 
@@ -65,7 +65,7 @@ module Recurly
 
       before(:each) do
         credit = Factory.create_credit account.account_code,
-                                        :amount => 13.15,
+                                        :amount_in_cents => 1315,
                                         :description => "free moniez 4 u"
         @credit = Credit.lookup(account.account_code, credit.id)
       end
@@ -89,7 +89,7 @@ module Recurly
 
       before(:each) do
         credit = Factory.create_credit account.account_code,
-                                        :amount => 13.15,
+                                        :amount_in_cents => 1315,
                                         :description => "free moniez 4 u"
         @credit = Credit.lookup(account.account_code, credit.id)
 

data/spec/integration/plan_spec.rb

@@ -64,7 +64,7 @@ module Recurly
           Plan.new({
             :plan_code => "test",
             :name => "Test Plan",
-            :unit_amount_in_cents => 100,
+            :amount_in_cents => 100,
             :plan_interval_length => 1,
             :plan_interval_unit => "months",
             :trial_interval_length => 0,
@@ -75,7 +75,7 @@ module Recurly
       end
 
       it "should update the plan" do
-        @test_plan.unit_amount_in_cents = 200
+        @test_plan.amount_in_cents = 200
         @test_plan.save!
 
         @test_plan = test_plan

data/spec/support/factory.rb

@@ -45,6 +45,8 @@ module Recurly
     # returns a hash of billing information
     def self.billing_attributes(address_overrides = {}, credit_card_overrides = {})
       attributes = {
+        :first_name => 'Verena',
+        :last_name => 'Test',
         :address1 => '123 Test St',
         :city => 'San Francisco',
         :state => 'CA',
@@ -153,7 +155,7 @@ module Recurly
     def self.create_credit(account_code, attributes = {})
       credit = Credit.new({
         :account_code => account_code,
-        :amount => 10.00,
+        :amount_in_cents => 1000,
         :description => "free moniez"
       }.merge(attributes))
       credit.save!
@@ -166,7 +168,7 @@ module Recurly
         :name => "Trial",
 
         # 10 dollars a month
-        :unit_amount_in_cents => 1000,
+        :amount_in_cents => 1000,
 
         # 1 month intervals
         :plan_interval_length => 1,
@@ -184,7 +186,7 @@ module Recurly
         :name => "Paid",
 
         # 10 dollars a month
-        :unit_amount_in_cents => 1000,
+        :amount_in_cents => 1000,
 
         # 1 month intervals
         :plan_interval_length => 1,

data/spec/unit/account_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Recurly
+  describe Account do
+    context "new record" do
+      subject{Account.new}
+
+      it { should respond_to(:account_code)}
+      it { should respond_to(:username)}
+      it { should respond_to(:first_name)}
+      it { should respond_to(:last_name)}
+      it { should respond_to(:email)}
+      it { should respond_to(:company_name)}
+      it { should respond_to(:hosted_login_token)}
+      it { should respond_to(:accept_language)}
+    end
+
+  end
+end