chartmogul-ruby 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af78d54ace12411026ce9ee9a25248f092428f2c
-  data.tar.gz: 4fd3512f3b39ee8df129f94cf2994f7cc0983fdc
+  metadata.gz: dd14d80ca5ef6ec9a672747aa43aa42c3c2273d6
+  data.tar.gz: eff41878d6cdf81a006ab2870389aae11846651b
 SHA512:
-  metadata.gz: 1b317b68430c609ba27240dd6fdd12f7ab92293b72d11dd45813e937af7d509e71ddc185d19964bf199be02433001a00dba04d4d4a6c9f95467c65fdf53b3a91
-  data.tar.gz: 60ef9540f2486f9ee9cad87a327df056e12c300a04e44a7051d04bfcf21e3e0e33a6d31be863e657f437abeb9c08db235b64aab1933654dbfd04266ded1438e0
+  metadata.gz: 786c4423ba62345bf5c66a71e8c13ca68a2dbd0fc5349ebf78b943e3fcc04df4f8a269efe1723821922add7c0912f35bdc0b8ca2c33926800d3b1b98eafe1d78
+  data.tar.gz: 97e57e5a0590f2ec2cdda4219980e6686c567e6555dde5358089b30018a9358370dd032dd450cc34f00850a4c7a5a122eea0ab308b35f133ed68c2def84ebb5a

data/fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/can_page_through_search_endpoint.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/customers/search?email=adam%40smith.com&page=2&per_page=1
+    body:
+      encoding: UTF-8
+      string: '{}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic MDFiNzI2YzI0ZjNiYjhlOTc0MmEwNGZiMDhhZmE3NzQ6NzJlNGMxYTdlZTFiYzlkNGZjMDBlZWUwNWIyN2QzMGY=
+  response:
+    status:
+      code: 200
+      message:
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Wed, 29 Jun 2016 12:47:11 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '740'
+      connection:
+      - close
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: '{"entries":[{"id":20268060,"uuid":"cus_07393ece-aab1-4255-8bcd-0ef11e24b047","external_id":"cus_0001","name":"Adam
+        Smith","email":"adam@smith.com","status":"Cancelled","customer-since":"2016-05-01T12:00:00+00:00","attributes":{"tags":["another-tag"],"custom":{"string_key":"Another
+        String Value","integer_key":"5678","timestamp_key":"2016-02-01 00:00:00 UTC","boolean_key":"f"}},"address":{"country":"United
+        States","state":null,"city":"New York","address_line1":null,"address_line2":null,"address_zip":""},"mrr":0,"arr":0,"billing-system-url":null,"chartmogul-url":"https://app.chartmogul.com/#customers/cus_07393ece-aab1-4255-8bcd-0ef11e24b047-Adam_Smith","billing-system-type":"ImportApi","currency":"USD","currency-sign":"$"}],"has_more":false,"per_page":1,"page":2}'
+    http_version:
+  recorded_at: Wed, 29 Jun 2016 12:47:11 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/ChartMogul_Subscription/API_Interactions/has_multiple_aliases.yml

@@ -0,0 +1,101 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/import/customers/cus_510b1395-4fe8-4d35-ae23-0e61f9a51e33/subscriptions?page=1&per_page=2
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YmIzN2I0Njk5NjNlMjhlYjY2MjA1ZWYzZmU1MWQ1NmM6ZmM1YjQxYzM3YTNlZTcwYjQyN2UwYzU1ODg2NzA2ZmQ=
+  response:
+    status:
+      code: 200
+      message:
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Thu, 23 Jun 2016 20:46:07 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      x-frame-options:
+      - SAMEORIGIN
+      x-xss-protection:
+      - 1; mode=block
+      x-content-type-options:
+      - nosniff
+      etag:
+      - W/"797037ae5a33dcae7de46e23dfdd4ec7"
+      cache-control:
+      - max-age=0, private, must-revalidate
+      x-request-id:
+      - efa1a67e-37e8-4ac3-bce7-8d11f33d0e8c
+      x-runtime:
+      - '0.026716'
+      strict-transport-security:
+      - max-age=15768000
+    body:
+      encoding: UTF-8
+      string: '{"customer_uuid":"cus_510b1395-4fe8-4d35-ae23-0e61f9a51e33","subscriptions":[{"uuid":"sub_9b3ccf25-4613-4af6-84b3-12026cfa4b7c","external_id":"test_cus_sub_ext_id","cancellation_dates":[],"plan_uuid":"pl_06ea83a9-f8c8-4ddd-a980-9ceffd27f107","data_source_uuid":"ds_55ab11fb-53e6-4468-aa95-bd582f14cac6"}],"current_page":1,"total_pages":1}'
+    http_version:
+  recorded_at: Thu, 23 Jun 2016 20:46:07 GMT
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/import/customers/cus_510b1395-4fe8-4d35-ae23-0e61f9a51e33/subscriptions?page=2&per_page=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic YmIzN2I0Njk5NjNlMjhlYjY2MjA1ZWYzZmU1MWQ1NmM6ZmM1YjQxYzM3YTNlZTcwYjQyN2UwYzU1ODg2NzA2ZmQ=
+  response:
+    status:
+      code: 200
+      message:
+    headers:
+      server:
+      - nginx/1.9.10
+      date:
+      - Thu, 23 Jun 2016 20:46:07 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      x-frame-options:
+      - SAMEORIGIN
+      x-xss-protection:
+      - 1; mode=block
+      x-content-type-options:
+      - nosniff
+      etag:
+      - W/"797037ae5a33dcae7de46e23dfdd4ec7"
+      cache-control:
+      - max-age=0, private, must-revalidate
+      x-request-id:
+      - efa1a67e-37e8-4ac3-bce7-8d11f33d0e8c
+      x-runtime:
+      - '0.026716'
+      strict-transport-security:
+      - max-age=15768000
+    body:
+      encoding: UTF-8
+      string: '{"customer_uuid":"cus_510b1395-4fe8-4d35-ae23-0e61f9a51e33","subscriptions":[{"uuid":"sub_9b3ccf25-4613-4af6-84b3-12026cfa4b7c","external_id":"test_cus_sub_ext_id","cancellation_dates":[],"plan_uuid":"pl_06ea83a9-f8c8-4ddd-a980-9ceffd27f107","data_source_uuid":"ds_55ab11fb-53e6-4468-aa95-bd582f14cac6"}],"current_page":2,"total_pages":2}'
+    http_version:
+  recorded_at: Thu, 23 Jun 2016 20:46:07 GMT
+recorded_with: VCR 3.0.3

data/lib/chartmogul/api/actions/all.rb

@@ -14,12 +14,7 @@ module ChartMogul
               end
             end
             json = ChartMogul::Utils::JSONParser.parse(resp.body)
-
-            if resource_root_key && json.key?(resource_root_key)
-              json[resource_root_key].map { |attributes| new_from_json(attributes) }
-            else
-              new_from_json(json)
-            end
+            new_from_json(json)
           end
         end
       end

data/lib/chartmogul/api/actions/custom.rb

@@ -28,12 +28,7 @@ module ChartMogul
 
           def custom!(http_method, http_path, body_data = {})
             json = custom_without_assign!(http_method, http_path, body_data)
-
-            if resource_root_key && json.key?(resource_root_key)
-              json[resource_root_key].map { |attributes| new_from_json(attributes) }
-            else
-              new_from_json(json)
-            end
+            new_from_json(json)
           end
         end
       end

data/lib/chartmogul/api_resource.rb

@@ -17,7 +17,7 @@ module ChartMogul
     def self.set_resource_root_key(root_key)
       @resource_root_key = root_key
     end
-
+    
     def self.connection
       @connection ||= Faraday.new(url: ChartMogul::API_BASE) do |faraday|
         faraday.use Faraday::Request::BasicAuthentication, ChartMogul.account_token, ChartMogul.secret_key

data/lib/chartmogul/concerns/entries.rb

@@ -3,15 +3,25 @@ module ChartMogul
     module Entries
       def self.included(base)
         base.extend ClassMethods
-        base.send :prepend, InstanceMethods
 
         base.instance_eval do
-          readonly_attr :entries, default: []
+          if @resource_root_key.nil?
+            @resource_root_key = :entries
+          end
+          readonly_attr @resource_root_key, default: []
 
           include API::Actions::All
 
           include Enumerable
-          def_delegators :entries, :each, :[], :<<, :size, :length
+          def_delegators @resource_root_key, :each, :[], :<<, :size, :length, :empty?, :first
+
+          resource_root_key = @resource_root_key.to_s
+          base.send :define_method, "set_" + resource_root_key do |entries|
+            objects = entries.map do |entity|
+              self.class.get_entry_class.new_from_json(entity)
+            end
+            self.instance_variable_set "@#{resource_root_key}", objects
+          end
         end
       end
 
@@ -24,14 +34,6 @@ module ChartMogul
           instance_variable_get("@entry_class")
         end
       end
-
-      module InstanceMethods
-        def set_entries(entries_attributes)
-          @entries = entries_attributes.map do |entity|
-            self.class.get_entry_class.new_from_json(entity)
-          end
-        end
-      end
     end
   end
 end

data/lib/chartmogul/customer.rb

@@ -45,8 +45,8 @@ module ChartMogul
       custom!(:get, "/v1/customers/#{uuid}")
     end
 
-    def self.search(email)
-      Customers.search(email)
+    def self.search(email, options = {})
+      Customers.search(email, options)
     end
 
     def self.find_by_external_id(external_id)
@@ -147,9 +147,9 @@ module ChartMogul
 
     set_entry_class Customer
 
-    def self.search(email)
+    def self.search(email, options = {})
       path = ChartMogul::ResourcePath.new('/v1/customers/search')
-      custom!(:get, path.apply_with_get_params(email: email))
+      custom!(:get, path.apply_with_get_params(options.merge(email: email)))
     end
   end
 end

data/lib/chartmogul/customer_invoices.rb

@@ -14,6 +14,7 @@ module ChartMogul
 
     include API::Actions::All
     include API::Actions::Create
+    include Concerns::Pageable2
 
     def serialize_invoices
       map(&:serialize_for_write)
@@ -23,10 +24,11 @@ module ChartMogul
       super(options.merge(customer_uuid: customer_uuid))
     end
 
-    def_delegators :invoices, :each, :[], :<<, :size, :length
+    def_delegators :invoices, :each, :[], :<<, :size, :length, :empty?, :first
 
     private
 
+    # TODO: replace with Entries concern?
     def set_invoices(invoices_attributes)
       @invoices = invoices_attributes.map.with_index do |invoice_attributes, index|
         existing_invoice = invoices[index]

data/lib/chartmogul/data_source.rb

@@ -2,7 +2,6 @@ module ChartMogul
   class DataSource < APIResource
     set_resource_name 'Data Source'
     set_resource_path '/v1/data_sources'
-    set_resource_root_key :data_sources
 
     readonly_attr :uuid
     readonly_attr :status
@@ -19,5 +18,21 @@ module ChartMogul
     def self.retrieve(uuid)
       custom!(:get, "/v1/data_sources/#{uuid}")
     end
+
+    def self.all(options = {})
+      DataSources.all(options)
+    end
+  end
+
+
+  class DataSources < APIResource
+    set_resource_name 'Data Sources'
+    set_resource_path '/v1/data_sources'
+
+    set_resource_root_key :data_sources
+
+    include Concerns::Entries
+
+    set_entry_class DataSource
   end
 end

data/lib/chartmogul/metrics/subscription.rb

@@ -2,6 +2,7 @@ module ChartMogul
   module Metrics
     class Subscription < ChartMogul::Object
       readonly_attr :id
+      readonly_attr :external_id
       readonly_attr :plan
       readonly_attr :quantity
       readonly_attr :mrr
@@ -34,4 +35,3 @@ module ChartMogul
     end
   end
 end
-

data/lib/chartmogul/plan.rb

@@ -2,7 +2,6 @@ module ChartMogul
   class Plan < APIResource
     set_resource_name 'Plan'
     set_resource_path '/v1/plans'
-    set_resource_root_key :plans
 
     readonly_attr :uuid
 
@@ -13,7 +12,6 @@ module ChartMogul
 
     writeable_attr :data_source_uuid
 
-    include API::Actions::All
     include API::Actions::Create
     include API::Actions::Update
     include API::Actions::Destroy
@@ -22,5 +20,22 @@ module ChartMogul
     def self.retrieve(uuid)
       custom!(:get, "/v1/plans/#{uuid}")
     end
+
+    def self.all(options = {})
+      Plans.all(options)
+    end
+  end
+  
+
+  class Plans < APIResource
+    set_resource_name 'Plans'
+    set_resource_path '/v1/plans'
+
+    set_resource_root_key :plans
+
+    include Concerns::Entries
+    include Concerns::Pageable2
+
+    set_entry_class Plan
   end
 end

data/lib/chartmogul/subscription.rb

@@ -2,7 +2,6 @@ module ChartMogul
   class Subscription < APIResource
     set_resource_name 'Subscription'
     set_resource_path '/v1/import/customers/:customer_uuid/subscriptions'
-    set_resource_root_key :subscriptions
 
     readonly_attr :uuid
     readonly_attr :external_id
@@ -11,7 +10,6 @@ module ChartMogul
     readonly_attr :plan_uuid
     readonly_attr :data_source_uuid
 
-    include API::Actions::All
     include API::Actions::Custom
 
     def set_cancellation_dates(cancellation_dates_array)
@@ -24,8 +22,27 @@ module ChartMogul
       custom!(:patch, "/v1/import/subscriptions/#{uuid}", cancelled_at: cancelled_at)
     end
 
+    def self.all(customer_uuid, options = {})
+      Subscriptions.all(customer_uuid, options)
+    end
+  end
+
+  class Subscriptions < APIResource
+    readonly_attr :customer_uuid
+
+    set_resource_name 'Subscriptions'
+    set_resource_path '/v1/import/customers/:customer_uuid/subscriptions'
+
+    set_resource_root_key :subscriptions
+
+    include Concerns::Entries
+    include Concerns::Pageable2
+
+    set_entry_class Subscription
+
     def self.all(customer_uuid, options = {})
       super(options.merge(customer_uuid: customer_uuid))
     end
+
   end
 end

data/lib/chartmogul/version.rb

@@ -1,3 +1,3 @@
 module ChartMogul
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartmogul-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jason Langenauer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,6 +114,7 @@ files:
 - chartmogul-ruby.gemspec
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/adds_custom_attributes.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/adds_required_tags.yml
+- fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/can_page_through_search_endpoint.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/correctly_handles_a_422_response.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/correctly_interracts_with_the_API.yml
 - fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/merges_customers.yml
@@ -163,6 +164,7 @@ files:
 - fixtures/vcr_cassettes/ChartMogul_Plan/API_Interactions/retrieves_existing_plan_by_uuid.yml
 - fixtures/vcr_cassettes/ChartMogul_Plan/API_Interactions/updates_existing_plan.yml
 - fixtures/vcr_cassettes/ChartMogul_Subscription/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Subscription/API_Interactions/has_multiple_aliases.yml
 - fixtures/vcr_cassettes/ChartMogul_Transactions_Payment/API_Interactions/correctly_interracts_with_the_API.yml
 - lib/chartmogul.rb
 - lib/chartmogul/api/actions/all.rb