rspreedly 0.1.14 → 0.1.15

data/Rakefile

@@ -20,7 +20,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "rspreedly"
-  s.version           = "0.1.14"
+  s.version           = "0.1.15"
   s.summary           = "Ruby library for the Spreedly API"
   s.author            = "Richard Livsey"
   s.email             = "richard@livsey.org"

data/lib/rspreedly/subscriber.rb

@@ -26,13 +26,14 @@ module RSpreedly
                   :store_credit_currency_code,
                   :subscription_plan_name,
                   :token,
-                  :updated_at
+                  :updated_at,
+                  :invoices
 
     class << self
 
       # Get a subscriber’s details
-      # GET /api/v4/[short site name]/subscribers/[subscriber id].xml    
-      def find(id)      
+      # GET /api/v4/[short site name]/subscribers/[subscriber id].xml
+      def find(id)
         return all if id == :all
 
         begin
@@ -44,7 +45,7 @@ module RSpreedly
       end
 
       # Get a list of all subscribers (more)
-      # GET /api/v4/[short site name]/subscribers.xml    
+      # GET /api/v4/[short site name]/subscribers.xml
       def all
         response = api_request(:get, "/subscribers.xml")
         return [] unless response.has_key?("subscribers")
@@ -54,13 +55,23 @@ module RSpreedly
       # Clear all subscribers from a *test* site (more)
       # DELETE /api/v4/[short site name]/subscribers.xml
       def delete_all
-        !! api_request(:delete, "/subscribers.xml")      
+        !! api_request(:delete, "/subscribers.xml")
       end
 
       alias_method :destroy_all, :delete_all
 
     end
 
+    def invoices=(data)
+      @invoices = []
+      data.each do |item|
+        if item.is_a? Hash
+          item = RSpreedly::Invoice.new(item)
+        end
+        @invoices << item
+      end
+    end
+
     def new_record?
       !self.token
     end
@@ -74,7 +85,7 @@ module RSpreedly
     end
 
     # Create a subscriber (more)
-    # POST /api/v4/[short site name]/subscribers.xml    
+    # POST /api/v4/[short site name]/subscribers.xml
     def create!
       result = api_request(:post, "/subscribers.xml", :body => self.to_xml)
       self.attributes = result["subscriber"]
@@ -92,7 +103,7 @@ module RSpreedly
     end
 
     # Update a Subscriber (more)
-    # PUT /api/v4/[short site name]/subscribers/[subscriber id].xml    
+    # PUT /api/v4/[short site name]/subscribers/[subscriber id].xml
     def update!
       !! api_request(:put, "/subscribers/#{self.customer_id}.xml", :body => self.to_xml(:exclude => [:customer_id]))
     end
@@ -104,22 +115,22 @@ module RSpreedly
         # gulp those errors down
         # TODO - set self.errors or something?
         nil
-      end      
+      end
     end
 
     # Delete one subscriber from a *test* site (more)
-    # DELETE /api/v4/[short site name]/subscribers/[subscriber id].xml    
+    # DELETE /api/v4/[short site name]/subscribers/[subscriber id].xml
     def destroy
       begin
         !! api_request(:delete, "/subscribers/#{self.customer_id}.xml")
       rescue RSpreedly::Error::NotFound
         nil
-      end      
+      end
     end
     alias_method :delete, :destroy
 
     # Give a subscriber a complimentary subscription (more)
-    # POST /api/v4/[short site name]/subscribers/[subscriber id]/complimentary_subscriptions.xml    
+    # POST /api/v4/[short site name]/subscribers/[subscriber id]/complimentary_subscriptions.xml
     def comp_subscription(subscription)
       result = api_request(:post, "/subscribers/#{self.customer_id}/complimentary_subscriptions.xml", :body => subscription.to_xml)
       self.attributes = result["subscriber"]
@@ -154,7 +165,7 @@ module RSpreedly
     def subscribe_to_free_trial(plan)
       result = api_request(:post, "/subscribers/#{self.customer_id}/subscribe_to_free_trial.xml", :body => plan.to_xml)
       self.attributes = result["subscriber"]
-      true      
+      true
     end
 
     # Programatically Allow Another Free Trial (more)
@@ -162,33 +173,33 @@ module RSpreedly
     def allow_free_trial
       result = api_request(:post, "/subscribers/#{self.customer_id}/allow_free_trial.xml")
       self.attributes = result["subscriber"]
-      true            
+      true
     end
-    
+
     def grant_lifetime_subscription(feature_level)
       subscription = LifetimeComplimentarySubscription.new(:feature_level => feature_level)
       result = api_request(:post, "/subscribers/#{self.customer_id}/lifetime_complimentary_subscriptions.xml", :body => subscription.to_xml)
       self.attributes = result["subscriber"]
       true
     end
-    
+
     def to_xml(opts={})
-      
+
       # the api doesn't let us send these things
       # so let's strip them out of the XML
       exclude = [
-        :active,       :active_until,               :card_expires_before_next_auto_renew, 
-        :created_at,   :eligible_for_free_trial,    :feature_level, 
-        :grace_until,  :in_grace_period,            :lifetime_subscription, 
-        :on_trial,     :ready_to_renew,             :recurring, 
-        :store_credit, :store_credit_currency_code, :subscription_plan_name,   
+        :active,       :active_until,               :card_expires_before_next_auto_renew,
+        :created_at,   :eligible_for_free_trial,    :feature_level,
+        :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,                 :ready_to_renew_since
       ]
-      
+
       opts[:exclude] ||= []
       opts[:exclude] |= exclude
-      
-      super(opts)      
+
+      super(opts)
     end
   end
 end

data/rspreedly.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rspreedly}
-  s.version = "0.1.14"
+  s.version = "0.1.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Livsey"]

data/spec/fixtures/subscriber.xml

@@ -22,4 +22,139 @@
   <in_grace_period type="boolean"></in_grace_period>
   <on-trial type="boolean">false</on-trial>
   <feature-level type="string"></feature-level>
+  <invoices type="array">
+    <invoice>
+      <closed type="boolean">true</closed>
+      <created-at type="datetime">2011-07-21T19:04:45Z</created-at>
+      <response-client-message nil="true"></response-client-message>
+      <response-customer-message nil="true"></response-customer-message>
+      <response-message nil="true"></response-message>
+      <token>46089ee32310b4983c6acb0bc02dec955886d411</token>
+      <updated-at type="datetime">2011-07-21T19:05:07Z</updated-at>
+      <price>$0.05</price>
+      <amount type="decimal">0.05</amount>
+      <currency-code>USD</currency-code>
+      <line-items type="array">
+        <line-item>
+          <amount type="decimal">99.0</amount>
+          <currency-code>USD</currency-code>
+          <description>Every 1 month</description>
+          <notes nil="true"></notes>
+          <price>$99.00</price>
+        </line-item>
+        <line-item>
+          <amount type="decimal">-48.99</amount>
+          <currency-code>USD</currency-code>
+          <description>Credit from current subscription</description>
+          <notes nil="true"></notes>
+          <price>$-48.99</price>
+        </line-item>
+        <line-item>
+          <amount type="decimal">-49.96</amount>
+          <currency-code>USD</currency-code>
+          <description>Your store credit</description>
+          <notes nil="true"></notes>
+          <price>$-49.96</price>
+        </line-item>
+      </line-items>
+    </invoice>
+    <invoice>
+      <closed type="boolean">true</closed>
+      <created-at type="datetime">2011-07-21T18:56:52Z</created-at>
+      <response-client-message nil="true"></response-client-message>
+      <response-customer-message nil="true"></response-customer-message>
+      <response-message nil="true"></response-message>
+      <token>4730937c43a57b333b78ba474e6384bfb434bee3</token>
+      <updated-at type="datetime">2011-07-21T18:57:12Z</updated-at>
+      <price>$-49.96</price>
+      <amount type="decimal">-49.96</amount>
+      <currency-code>USD</currency-code>
+      <line-items type="array">
+        <line-item>
+          <amount type="decimal">49.0</amount>
+          <currency-code>USD</currency-code>
+          <description>Every 1 month</description>
+          <notes nil="true"></notes>
+          <price>$49.00</price>
+        </line-item>
+        <line-item>
+          <amount type="decimal">-98.96</amount>
+          <currency-code>USD</currency-code>
+          <description>Credit from current subscription</description>
+          <notes nil="true"></notes>
+          <price>$-98.96</price>
+        </line-item>
+      </line-items>
+    </invoice>
+    <invoice>
+      <closed type="boolean">true</closed>
+      <created-at type="datetime">2011-07-21T18:39:17Z</created-at>
+      <response-client-message nil="true"></response-client-message>
+      <response-customer-message nil="true"></response-customer-message>
+      <response-message nil="true"></response-message>
+      <token>4bf20627d684dbaab231b349b1ed1ae6388f4ffc</token>
+      <updated-at type="datetime">2011-07-21T18:39:32Z</updated-at>
+      <price>$50.00</price>
+      <amount type="decimal">50.0</amount>
+      <currency-code>USD</currency-code>
+      <line-items type="array">
+        <line-item>
+          <amount type="decimal">99.0</amount>
+          <currency-code>USD</currency-code>
+          <description>Every 1 month</description>
+          <notes nil="true"></notes>
+          <price>$99.00</price>
+        </line-item>
+        <line-item>
+          <amount type="decimal">-49.0</amount>
+          <currency-code>USD</currency-code>
+          <description>Credit from current subscription</description>
+          <notes nil="true"></notes>
+          <price>$-49.00</price>
+        </line-item>
+      </line-items>
+    </invoice>
+    <invoice>
+      <closed type="boolean">true</closed>
+      <created-at type="datetime">2011-07-21T18:15:11Z</created-at>
+      <response-client-message nil="true"></response-client-message>
+      <response-customer-message nil="true"></response-customer-message>
+      <response-message nil="true"></response-message>
+      <token>a5190437c9651aa77ac6e39e9833b579bff4658e</token>
+      <updated-at type="datetime">2011-07-21T18:15:36Z</updated-at>
+      <price>$49.00</price>
+      <amount type="decimal">49.0</amount>
+      <currency-code>USD</currency-code>
+      <line-items type="array">
+        <line-item>
+          <amount type="decimal">49.0</amount>
+          <currency-code>USD</currency-code>
+          <description>Every 1 month</description>
+          <notes nil="true"></notes>
+          <price>$49.00</price>
+        </line-item>
+      </line-items>
+    </invoice>
+    <invoice>
+      <closed type="boolean">true</closed>
+      <created-at type="datetime">2011-07-21T18:14:07Z</created-at>
+      <response-client-message nil="true"></response-client-message>
+      <response-customer-message nil="true"></response-customer-message>
+      <response-message nil="true"></response-message>
+      <token>ea7a657f68908279fdc33c8cf1c7037c4a2eec2d</token>
+      <updated-at type="datetime">2011-07-21T18:14:32Z</updated-at>
+      <price>$0.00</price>
+      <amount type="decimal">0.0</amount>
+      <currency-code>USD</currency-code>
+      <line-items type="array">
+        <line-item>
+          <amount type="decimal">0.0</amount>
+          <currency-code>USD</currency-code>
+          <description>Initial 1 month</description>
+          <notes>Subsequent Time Periods are $49.00 every 1 month</notes>
+          <price>$0.00</price>
+        </line-item>
+      </line-items>
+    </invoice>
+  </invoices>
 </subscriber>

data/spec/subscriber_spec.rb

@@ -22,6 +22,15 @@ describe RSpreedly::Subscriber do
 
       RSpreedly::Subscriber.find(42).should be_a(RSpreedly::Subscriber)
     end
+
+    it "should include invoices on the Subscriber" do
+      stub_request(:get, spreedly_url("/subscribers/42.xml")).
+        to_return(:body => fixture("subscriber.xml"), :status => 200)
+
+      subscriber = RSpreedly::Subscriber.find(42)
+      subscriber.invoices.size.should == 5
+      subscriber.invoices.select{|x| x.is_a?(RSpreedly::Invoice )}.size.should == 5
+    end
   end
 
   describe ".all" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspreedly
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2165032460 !ruby/object:Gem::Requirement
+  requirement: &2164641520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2165032460
+  version_requirements: *2164641520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165031860 !ruby/object:Gem::Requirement
+  requirement: &2164640940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165031860
+  version_requirements: *2164640940
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2165031220 !ruby/object:Gem::Requirement
+  requirement: &2164640420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165031220
+  version_requirements: *2164640420
 description: 
 email: richard@livsey.org
 executables: []