chargify_api_ares 1.1.0.pre → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01809c6f4c91b20f5829c4fdb5c2b08431e14289
-  data.tar.gz: 1d3b7638b00c56e4ab7a135c284264d173069343
+  metadata.gz: 487c9d4aadf7ce63e428362757dd6b64b49d9821
+  data.tar.gz: 02b33591e024bb01088183d31e2c1fca4eefe0d3
 SHA512:
-  metadata.gz: 6a84cbe5f8e4bb0d8fb999a5f9c033a1d903210205311213a93ff7e64705d9b6e71f71404c2637bbceaacfa68c67ff135e9c6a0014b5f023dac44b1774b158a6
-  data.tar.gz: 0f7553535d73a840bca38e7cefa0550de4f747ecf311983bb5559c5b44e9d0d32a1df3a4a609eaa2924dca785a4a5a3ec620197193b82c0536abfdd18ab6c3d7
+  metadata.gz: be4cd1efd96a30df19cd7711e17f643e19fb2cd8fe3d28f1cf0f980a1036bf9964576184eed62d2d4f4207cfe4c91b1468a80a976ec0ecf4ad4c356797660245
+  data.tar.gz: f505f8cf81d1c16a66a60da6c087f8d39a47d6722a2db1bcebcf6b46c73f1edb2e94124c9e816ee27f807148aba7eaaa170153b03e3e85726f4ccfcf2b366114

data/.env

@@ -0,0 +1,4 @@
+API_KEY='acme_test_key'
+SUBDOMAIN='acme'
+DOMAIN='chargify.dev'
+PROTOCOL='http'

data/.gitignore

@@ -6,3 +6,4 @@ pkg
 .bundle/
 bin/
 .rbenv-version
+tmp

data/.rspec

@@ -0,0 +1 @@
+--fail-fast --format d --color

data/.travis.yml

@@ -1,7 +1,16 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
   - 1.9.2
   - 1.8.7
   - ree
+  - jruby
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: ruby-head
+  fast_finish: true
+

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in chargify_api_ares.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargify_api_ares (1.0.5)
+    chargify_api_ares (1.1.0)
       activeresource (~> 3.2.16)
 
 GEM
@@ -19,6 +19,9 @@ GEM
     builder (3.0.4)
     coderay (1.0.8)
     diff-lcs (1.1.3)
+    dotenv (0.11.1)
+      dotenv-deployment (~> 0.0.2)
+    dotenv-deployment (0.0.2)
     factory_girl (2.6.4)
       activesupport (>= 2.3.9)
     faker (1.1.2)
@@ -56,12 +59,14 @@ GEM
     slop (3.4.3)
     terminal-table (1.4.5)
     thor (0.17.0)
+    vcr (2.9.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   chargify_api_ares!
+  dotenv
   factory_girl (~> 2.6)
   faker (~> 1.1.2)
   fakeweb (~> 1.3.0)
@@ -71,3 +76,4 @@ DEPENDENCIES
   rake (~> 10.0.3)
   rb-fsevent (~> 0.9.2)
   rspec (~> 2.12.0)
+  vcr

data/HISTORY.md

@@ -1,3 +1,12 @@
+## 1.1.0 / Aug 20 2014
+
+* Added cancellation message option for subscription canceling
+* restore 1.8.7 style hash syntax
+* Add metafields and metadata
+* Remove 'bank\_account' attribute from subscription upon save
+* Update Gemfile source to https://rubygems.org due to Bundler deprecation
+* Update payment\_profile on subscriptions to return credit\_card or bank\_account
+
 ## 1.0.5 / May 11 2014
 
 ### Backwards-incompatible changes

data/README.md

@@ -1,6 +1,6 @@
 Chargify API wrapper for Ruby (using ActiveResource)
 ====================================================
-[![build status](https://secure.travis-ci.org/chargify/chargify_api_ares.png)](http://travis-ci.org/chargify/chargify_api_ares)
+[![build status](https://secure.travis-ci.org/chargify/chargify_api_ares.png)](http://travis-ci.org/chargify/chargify_api_ares) [![Code Climate](https://codeclimate.com/github/chargify/chargify_api_ares/badges/gpa.svg)](https://codeclimate.com/github/chargify/chargify_api_ares)
 
 **Note:** we have bumped to v1.0.0 to indicate a backwards incompatible change to the responses from `Chargify::Subscription.charge` and `Chargify::Subscription.migrate`.  Please see the HISTORY.md for more information.
 

data/chargify_api_ares.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.7'
 
   s.name    = 'chargify_api_ares'
-  s.version = '1.1.0.pre'
-  s.date    = '2014-08-08'
+  s.version = '1.1.0'
+  s.date    = '2014-08-20'
   s.summary = 'A Chargify API wrapper for Ruby using ActiveResource'
   s.description = ''
   s.authors = ["Michael Klett", "Nathan Verni", "Jeremy W. Rowe", "Eric Farkas"]
@@ -29,4 +29,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency('growl', '~> 1.0.3')
   s.add_development_dependency('rb-fsevent', '~> 0.9.2')
   s.add_development_dependency('pry')
+  s.add_development_dependency('vcr')
+  s.add_development_dependency('dotenv')
 end

data/examples/metadata.rb

@@ -0,0 +1,58 @@
+require 'chargify_api_ares'
+
+Chargify.configure do |c|
+  c.subdomain = ENV['CHARGIFY_SUBDOMAIN']
+  c.api_key   = ENV['CHARGIFY_API_KEY']
+end
+
+subscription = Chargify::Subscription.last
+
+## Listing all of your customer metafields
+metadata = subscription.metadata
+# => [#<Chargify::SubscriptionMetadata resource_id: 22, current_name: favorite color, name: favorite color, value: red>]
+
+## creating new metadata
+subscription.create_metadata name: 'shoe size', value: '11w'
+# => #<Chargify::SubscriptionMetadata resource_id: 22, current_name: shoe size, name: shoe size, value: 11w>
+subscription.metadata
+# => [#<Chargify::SubscriptionMetadata resource_id: 22, current_name: favorite color, name: favorite color, value: red>,
+#     #<Chargify::SubscriptionMetadata resource_id: 22, current_name: shoe size, name: shoe size, value: 11w>]]
+
+## updating metadata value
+data = subscription.metadata.detect { |d| d.name == "shoe size" }
+# => #<Chargify::SubscriptionMetadata resource_id: 22, current_name: shoe size, name: shoe size, value: 11w>
+data.value = '10'
+data.save # => true
+data
+# => #<Chargify::SubscriptionMetadata resource_id: 22, current_name: shoe size, name: shoe size, value: 10>
+
+## updating metadata name
+data.name = 'height'
+data.save # => true
+data
+# => #<Chargify::SubscriptionMetadata resource_id: 22, current_name: height, name: height, value: 10>
+
+subscription.metadata
+# => [#<Chargify::SubscriptionMetadata resource_id: 22, current_name: favorite color, name: favorite color, value: red>,
+      #<Chargify::SubscriptionMetadata resource_id: 22, current_name: height, name: height, value: 10>]]
+
+# note - current_name is for internal tracking, and should not be changed. If you want to update the name of a metadata use the name field.
+#      - metadata can be created or updated by using create_metadata on the subscription. This is so you don't have to do a look up if you know
+#        the metadata name a head of time.
+
+# if you wish to make a new metadata without saving the record until later you can use the build_metadata method
+# building a metadata
+
+data = subscription.build_metadata
+# => #<Chargify::SubscriptionMetadata resource_id: 22, current_name: nil, name: nil, value: nil>
+data.persisted? # => false
+
+# do some internal work... and it returns results that you want to store it with a subscription
+
+data.name  = internal_work.computed_name
+data.value = Time.now
+data.save # => true
+data.persisted? # => true
+
+data
+# => #<Chargify::SubscriptionMetadata resource_id: 22, current_name: job 1234, name: job 1234, value: 2014-08-21 02:10:46 UTC>

data/examples/metafields.rb

@@ -0,0 +1,32 @@
+require 'chargify_api_ares'
+
+Chargify.configure do |c|
+  c.subdomain = ENV['CHARGIFY_SUBDOMAIN']
+  c.api_key   = ENV['CHARGIFY_API_KEY']
+end
+
+## Listing all of your customer metafields
+metafields = Chargify::CustomerMetafield.all
+# => [#<Chargify::CustomerMetafield current_name: favorite color, name: favorite color>]
+
+## Creating a new customer metafield
+field = Chargify::CustomerMetafield.create name: 'test'
+# => #<Chargify::CustomerMetafield current_name: test, name: test>
+field.persisted? # => true
+
+## Updating a persisted metafield
+field.name = 'new name'
+field.on_csv_export = true
+field.on_hosted_pages = 'all'
+field.save # => true
+
+field.on_csv_export?  # => true
+field.on_hosted_pages # => ["all"]
+
+## Listing all of your subscription metafields
+metafields = Chargify::SubscriptionMetafield.all
+# => [#<Chargify::SubscriptionMetafield current_name: favorite color, name: favorite color>]
+
+## Creating a new customer metafield
+field = Chargify::SubscriptionMetafield.create name: 'internal info'
+# => #<Chargify::SubscriptionMetafield current_name: internal info, name: internal info>

data/lib/chargify_api_ares.rb

@@ -1,7 +1,9 @@
 require 'active_resource'
 require 'chargify_api_ares/config'
+require 'chargify_api_ares/behaviors/inspectable'
+require 'chargify_api_ares/behaviors/metadata'
+require 'chargify_api_ares/behaviors/metafield'
 require 'chargify_api_ares/response_helper'
-require 'chargify_api_ares/metafield_xml_formatter'
 require 'chargify_api_ares/resources/base'
 require 'chargify_api_ares/resources/charge'
 require 'chargify_api_ares/resources/component'
@@ -15,12 +17,12 @@ require 'chargify_api_ares/resources/product_family'
 require 'chargify_api_ares/resources/renewal_preview'
 require 'chargify_api_ares/resources/site'
 require 'chargify_api_ares/resources/statement'
+require 'chargify_api_ares/resources/subscription_metadata'
 require 'chargify_api_ares/resources/subscription'
 require 'chargify_api_ares/resources/transaction'
 require 'chargify_api_ares/resources/usage'
 require 'chargify_api_ares/resources/webhook'
 require 'chargify_api_ares/resources/invoice'
-require 'chargify_api_ares/resources/metafield'
 require 'chargify_api_ares/resources/customer_metafield'
 require 'chargify_api_ares/resources/subscription_metafield'
 

data/lib/chargify_api_ares/behaviors/inspectable.rb

@@ -0,0 +1,33 @@
+module Chargify
+  module Behaviors
+    module Inspectable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def inspect
+        vals = self.class.inspect_instance.call(self)
+        vals = vals.map{|a| "#{a[0]}: #{nil_or_value(a[1])}"}.join(", ")
+        "#<#{self.class.name} #{vals}>"
+      end
+
+      private
+
+      def nil_or_value(value)
+        value || 'nil'
+      end
+
+      module ClassMethods
+        def inspect_instance=(value); @inspect_instance = value; end
+        def inspect_instance;         @inspect_instance;         end
+
+        def inspect_class=(value); @inspect_class = value; end
+        def inspect_class;         @inspect_class;         end
+
+        def inspect
+          "#{self.name}(#{self.inspect_class})"
+        end
+      end
+    end
+  end
+end

data/lib/chargify_api_ares/behaviors/metadata.rb

@@ -0,0 +1,61 @@
+module Chargify
+  module Behaviors
+    module Metadata
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def destroy
+        connection.delete("#{element_path}?current_name=#{URI.encode(current_name)}")
+      end
+
+      def resource_id=(value)
+        self.prefix_options = {:resource_id => value}
+      end
+
+      def element_path(id = nil, pre_options = {}, query_options = {})
+        collection_path(prefix_options)
+      end
+
+      def convert_attributes(attributes)
+        attributes.is_a?(Array) ? attributes.first : attributes
+      end
+
+      def load_attributes_from_response(response)
+        if (response_code_allows_body?(response.code) &&
+            (response['Content-Length'].nil? || response['Content-Length'] != "0") &&
+            !response.body.nil? && response.body.strip.size > 0)
+          attributes = self.class.format.decode(response.body)
+
+          # This is a major hack, but has to be done for metadata / metafields because we return
+          # an array instead of a single object
+          attributes = convert_attributes(attributes)
+
+          resource = load(attributes, true)
+          resource.current_name = resource.name
+          @persisted = true
+        end
+      end
+
+      module ClassMethods
+        def endpoint_name=(name)
+          (class << self; self; end).send(:define_method, :resource)     do;  name; end
+          (class << self; self; end).send(:define_method, :element_name) do;  name; end
+        end
+
+        def instantiate_collection(collection, prefix_options = {})
+          collection[self.resource].collect! { |record| instantiate_record(record, prefix_options) }
+        end
+
+        def instantiate_record(record, prefix_options = {})
+          record = record.is_a?(Array) ? record.first : record
+          new(record, true).tap do |resource|
+            resource.prefix_options = prefix_options
+            resource.current_name   = resource.name
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/chargify_api_ares/behaviors/metafield.rb

@@ -0,0 +1,30 @@
+module Chargify
+  module Behaviors
+    module Metafield
+      def on_csv_export?
+        scope.csv == "1" || scope.csv == true
+      end
+
+      def on_csv_export=(value)
+        value = (value == true || value == '1') ? '1' : '0'
+        scope.csv = value
+      end
+
+      def on_hosted_pages?
+        scope.hosted.any?
+      end
+
+      def on_hosted_pages=(*products)
+        scope.hosted = Array(products).flatten.map(&:to_s)
+      end
+
+      def on_hosted_pages
+        scope.hosted
+      end
+
+      def reload
+        raise NotImplementedError, 'Metafields do not support loading of a single record'
+      end
+    end
+  end
+end

data/lib/chargify_api_ares/resources/customer_metafield.rb

@@ -1,5 +1,18 @@
 module Chargify
-  class CustomerMetafield < Metafield
+  class CustomerMetafield < Base
+    include ::Chargify::Behaviors::Inspectable
+    include ::Chargify::Behaviors::Metafield
+    include ::Chargify::Behaviors::Metadata
+
     self.prefix = "/customers/"
+
+    self.inspect_class     = "current_name: string, name: string, scope: { hosted: [], csv: boolean }"
+    self.inspect_instance  = Proc.new {|s| [[:current_name, s.current_name], [:name, s.name]] }
+    self.endpoint_name     = 'metafields'
+
+    schema do
+      attribute 'current_name', :string
+      attribute 'name',         :string
+    end
   end
 end

data/lib/chargify_api_ares/resources/invoice.rb

@@ -2,19 +2,19 @@ module Chargify
   class Invoice < Base
 
     def self.find_by_invoice_id(id)
-      find(:first, params: {id: id})
+      find(:first, {:params => {:id => id}})
     end
 
     def self.find_by_subscription_id(id)
-      find(:all, params: {subscription_id: id})
+      find(:all, {:params => {:subscription_id => id}})
     end
 
     def self.unpaid_from_subscription(subscription_id)
-      find(:all, params: {subscription_id: subscription_id, state: "unpaid"})
+      find(:all, {:params => {:subscription_id => subscription_id, :state => "unpaid"}})
     end
 
     def self.unpaid
-      find(:all, params: {state: "unpaid"})
+      find(:all, {:params => {:state => "unpaid"}})
     end
   end
 end

data/lib/chargify_api_ares/resources/subscription.rb

@@ -12,11 +12,30 @@ module Chargify
       self.attributes.delete('customer')
       self.attributes.delete('product')
       self.attributes.delete('credit_card')
+      self.attributes.delete('bank_account')
       super
     end
 
-    def cancel
-      destroy
+    def cancel(cancellation_message = nil)
+      if cancellation_message.nil?
+        destroy
+      else
+        #Destory does not support body, must work around it to send verb DELETE
+        self.connection.post(element_path, {:cancellation_message => cancellation_message}.to_xml(:root => :subscription), self.class.headers.merge({'X-Http-Method-Override' => 'DELETE'}))
+      end
+    end
+
+    def build_metadata(params = {})
+      SubscriptionMetadata.new(params.reverse_merge({:resource_id => self.id}))
+    end
+
+    def create_metadata(params = {})
+      SubscriptionMetadata.create(params.reverse_merge({:resource_id => self.id}))
+    end
+
+    def metadata(params={})
+      params.merge!({:resource_id => self.id})
+      SubscriptionMetadata.find(:all, :params => params)
     end
 
     def component(id)
@@ -34,7 +53,11 @@ module Chargify
     end
 
     def payment_profile
-      self.respond_to?('credit_card') ? credit_card : nil
+      if self.respond_to?('credit_card')
+        credit_card
+      elsif self.respond_to?('bank_account')
+        bank_account
+      end
     end
 
     # Perform a one-time charge on an existing subscription.