chargify_api_ares 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69aa3faec2b2f60e39558318a569ece38bb66187
-  data.tar.gz: cb7a28a0c2fc9e08987403d00a129f77fe95956e
+  metadata.gz: 517070c73c5b29d20aa4e64911abf29ab10e29a5
+  data.tar.gz: 3c43ad57044a7ec35dca4c8ef2880fee801960ad
 SHA512:
-  metadata.gz: bef28b56c1a06782277d81435154ab1eb9e920b8dcc31c483d95024ae183e75e3b45b6b44c9a5b63be5a839f9426b81b4fed99b7157bed9eb555e9fdc163597f
-  data.tar.gz: e3b8d2728765d432d5ef3dde3378af5ab8bfc97b52e28d98b8899917b94d9d3fa99f8e8d86ecd3ab4993d607a4e5b8987160a480102478d40e446be24012276a
+  metadata.gz: 631f7b0c2d48cd712c8fdd5a59494b2821e2414ac61d9f94694297626dc78a8b544f8593bbc6a471517cca025b9f78e81a02af525aa66d5f5d5d7917a2773df8
+  data.tar.gz: a86e0a7db2d4f7dc0e069860d3f45719aec38abd2c85ec4146e056acb1df5a9dc2279e8e186b901065971b1c4dc8efeba3667493d9c945f09130785a34d23264

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargify_api_ares (1.4.4)
+    chargify_api_ares (1.4.5)
       activeresource (>= 3.2.16)
 
 GEM
@@ -67,4 +67,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/HISTORY.md

@@ -1,3 +1,8 @@
+## 1.4.5 / July 14 2016
+
+* Adds ability to find pdfs from invoices, show subscription invoices [PR 135] (https://github.com/chargify/chargify_api_ares/pull/135)
+
+
 ## 1.4.4 / Jun 3 2016
 
 * Adds support for External Payments [PR 128](https://github.com/chargify/chargify_api_ares/pull/128)

data/chargify_api_ares.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.specification_version = 3 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version          = '1.3.7'
 
   s.name        = 'chargify_api_ares'
-  s.version     = '1.4.4'
-  s.date        = '2016-06-03'
+  s.version     = '1.4.5'
+  s.date        = '2016-07-14'
   s.summary     = 'A Chargify API wrapper for Ruby using ActiveResource'
   s.description = ''
   s.authors     = ["Chargify Development Team"]

data/gemfiles/rails_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    chargify_api_ares (1.4.4)
+    chargify_api_ares (1.4.5)
       activeresource (>= 3.2.16)
 
 GEM
@@ -128,4 +128,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/gemfiles/rails_4.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    chargify_api_ares (1.4.4)
+    chargify_api_ares (1.4.5)
       activeresource (>= 3.2.16)
 
 GEM
@@ -27,10 +27,10 @@ GEM
       activemodel (= 4.1.6)
       activesupport (= 4.1.6)
       arel (~> 5.0.0)
-    activeresource (4.0.0)
+    activeresource (4.1.0)
       activemodel (~> 4.0)
       activesupport (~> 4.0)
-      rails-observers (~> 0.1.1)
+      rails-observers (~> 0.1.2)
     activesupport (4.1.6)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
@@ -128,4 +128,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    chargify_api_ares (1.4.4)
+    chargify_api_ares (1.4.5)
       activeresource (>= 3.2.16)
 
 GEM
@@ -25,10 +25,10 @@ GEM
       activesupport (= 4.0.12)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activeresource (4.0.0)
+    activeresource (4.1.0)
       activemodel (~> 4.0)
       activesupport (~> 4.0)
-      rails-observers (~> 0.1.1)
+      rails-observers (~> 0.1.2)
     activesupport (4.0.12)
       i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
@@ -122,4 +122,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/lib/chargify_api_ares/resources/invoice.rb

@@ -16,5 +16,13 @@ module Chargify
     def self.unpaid
       find(:all, {:params => {:state => "unpaid"}})
     end
+
+    # Returns raw PDF data. Usage example:
+    # File.open(file_path, 'wb+'){ |f| f.write Chargify::Invoice.find_pdf(invoice.id) }
+    def self.find_pdf(scope, options = {})
+      prefix_options, query_options = split_options(options[:params])
+      path = element_path(scope, prefix_options, query_options).gsub(/\.\w+$/, ".pdf")
+      connection.get(path, headers).body
+    end
   end
 end

data/lib/chargify_api_ares/resources/subscription.rb

@@ -123,6 +123,17 @@ module Chargify
       Statement.find(:all, :params => params)
     end
 
+    def invoices(params = {})
+      params.merge!(subscription_id: self.id)
+      Invoice.find(:all, params: params)
+    end
+
+    def invoice(id)
+      invoice = Chargify::Invoice.find(id)
+      raise ActiveResource::ResourceNotFound.new(nil) if (invoice.subscription_id != self.id)
+      invoice
+    end
+
     def transactions(params = {})
       params.merge!(:subscription_id => self.id)
       Transaction.find(:all, :params => params)

data/spec/resources/invoice_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Chargify::Invoice, :fake_resource do
+
+  describe '.find_pdf' do
+    before do
+      FakeWeb.register_uri(:get, "#{test_domain}/invoices/1.pdf", body: 'fake_pdf')
+    end
+
+    it 'downloads pdf statement' do
+      pdf = Chargify::Invoice.find_pdf(1)
+      pdf.should == 'fake_pdf'
+    end
+  end
+
+end

data/spec/resources/subscription_spec.rb

@@ -145,4 +145,113 @@ describe Chargify::Subscription, :fake_resource do
       end
     end
   end
+
+  describe "#statements" do
+    let(:subscription_id) {1}
+    let(:statements) do
+      [{id: 1234}, {id: 5678}]
+    end
+
+    before do
+      FakeWeb.register_uri(
+        :get,
+        "#{test_domain}/subscriptions/#{subscription_id}/statements.xml",
+        status: 201,
+        body: statements.to_xml
+      )
+    end
+
+    it "lists statements" do
+      subscription = build(:subscription, id: subscription_id)
+      expect(subscription.statements.first.id).to eq(1234)
+      expect(subscription.statements.last.id).to eq(5678)
+    end
+  end
+
+  describe "#statement" do
+    let(:statement_id) {1234}
+    let(:subscription_id) {4242}
+    let(:statement) do
+      {id: statement_id, subscription_id: subscription_id}
+    end
+
+    before do
+      FakeWeb.register_uri(
+        :get,
+        "#{test_domain}/statements/#{statement_id}.xml",
+        status: 201,
+        body: statement.to_xml
+      )
+    end
+
+    it "finds a statement" do
+      subscription = build(:subscription, id: subscription_id)
+      found = subscription.statement(statement_id)
+      expect(found.id).to eql(statement_id)
+      expect(found.subscription_id).to eql(subscription_id)
+    end
+
+    context "when attempting to query a statement not under this subscription" do
+      it "raises an error" do
+        subscription = build(:subscription, id: 9999)
+        expect {subscription.statement(statement_id)}.to raise_error(ActiveResource::ResourceNotFound)
+      end
+    end
+  end
+
+
+  describe "#invoices" do
+    let(:subscription_id) {1}
+    let(:invoices) do
+      [{id: 1234}, {id: 5678}]
+    end
+
+    before do
+      # Note this uses the invoices endpoint, passing subscription id as a param
+      FakeWeb.register_uri(
+        :get,
+        "#{test_domain}/invoices.xml?subscription_id=#{subscription_id}",
+        status: 201,
+        body: invoices.to_xml
+      )
+    end
+
+    it "lists invoices" do
+      subscription = build(:subscription, id: subscription_id)
+      expect(subscription.invoices.first.id).to eq(1234)
+      expect(subscription.invoices.last.id).to eq(5678)
+    end
+  end
+
+  describe "#invoice" do
+    let(:invoice_id) {1234}
+    let(:subscription_id) {4242}
+    let(:invoice) do
+      {id: invoice_id, subscription_id: subscription_id}
+    end
+
+    before do
+      FakeWeb.register_uri(
+        :get,
+        "#{test_domain}/invoices/#{invoice_id}.xml",
+        status: 201,
+        body: invoice.to_xml
+      )
+    end
+
+    it "finds an invoice" do
+      subscription = build(:subscription, id: subscription_id)
+      found = subscription.invoice(invoice_id)
+      expect(found.id).to eql(invoice_id)
+      expect(found.subscription_id).to eql(subscription_id)
+    end
+
+    context "when attempting to query an invoice not under this subscription" do
+      it "raises an error" do
+        subscription = build(:subscription, id: 9999)
+        expect {subscription.invoice(invoice_id)}.to raise_error(ActiveResource::ResourceNotFound)
+      end
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chargify_api_ares
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Chargify Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-03 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -233,6 +233,7 @@ files:
 - spec/resources/customer_metadata_spec.rb
 - spec/resources/customer_metafield_spec.rb
 - spec/resources/customer_spec.rb
+- spec/resources/invoice_spec.rb
 - spec/resources/migration_preview_spec.rb
 - spec/resources/migration_spec.rb
 - spec/resources/product_family_component_spec.rb
@@ -266,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 3
 summary: A Chargify API wrapper for Ruby using ActiveResource
@@ -286,6 +287,7 @@ test_files:
 - spec/resources/customer_metadata_spec.rb
 - spec/resources/customer_metafield_spec.rb
 - spec/resources/customer_spec.rb
+- spec/resources/invoice_spec.rb
 - spec/resources/migration_preview_spec.rb
 - spec/resources/migration_spec.rb
 - spec/resources/product_family_component_spec.rb