accepton 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71d2ad4d0b4dde6147bdd1cdbb4336c8856c1327
-  data.tar.gz: 1a2ace303f366f42e37296e860614f6fcb8f56ad
+  metadata.gz: c2d8dd63ba217851acd3120adcd40c3a36484fb7
+  data.tar.gz: ddc86a631827bf9e42d4a8c6ac4c40e2d31943fd
 SHA512:
-  metadata.gz: 8d5d12748a51aa3187839bcb989f77a3967b10a19f5e8aaf2b4962e4719ff9159703ada26a864db09d5b5aba48c47d5d213612c94a1df1587dae8739c73eeefe
-  data.tar.gz: 851ae6bb5e9e85249c044ea5436949ee2f04b1d6d9cfaebfd35f092f6ee563f77a916599e95a8cdf4c3ac7311f6fc7564de5b8f8069cd587ac833a80735192f2
+  metadata.gz: b8ed685a6ed7c27c5df7c16de285e4e2ca448c8ca3e044860b21a2bf8e83e88a59291e77852035bdf4495f29b089a017e395920dbf6dab5c53dc39b9aa4988f6
+  data.tar.gz: 52431b8ac177a975f574418e292949a1449e3468a7327ee7e69f9fd76dda344d8e58581b5ca47c340706a42653cc3caa33c6cbf235a2a84d1989a5d5a543f00b

data/CHANGELOG.md

@@ -6,6 +6,15 @@ scheme are considered to be bugs.
 
 [semver]: http://semver.org/spec/v2.0.0.html
 
+## [0.3.0][0.3.0] - 2015-11-06
+
+### Added
+
+- Added support for creating plans.
+- Added support for querying singular and lists of plans.
+- Added support for cancelling subscriptions.
+- Added support for querying singular and lists of subscriptions.
+
 ## [0.2.0][0.2.0] - 2015-09-18
 
 ### Added
@@ -18,5 +27,6 @@ scheme are considered to be bugs.
 
 - Initial version.
 
+[0.3.0]: https://github.com/accepton/accepton-ruby/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/accepton/accepton-ruby/compare/v0.1.0...v0.2.0
 [unreleased]: https://github.com/accepton/accepton-ruby/compare/v0.2.0...HEAD

data/lib/accepton.rb

@@ -9,4 +9,6 @@ require 'accepton/version'
 require 'accepton/base'
 require 'accepton/charge'
 require 'accepton/refund'
+require 'accepton/plan'
+require 'accepton/subscription'
 require 'accepton/transaction_token'

data/lib/accepton/api/planning.rb

@@ -0,0 +1,31 @@
+require 'accepton/api/utils'
+
+module AcceptOn
+  module API
+    module Planning
+      include AcceptOn::API::Utils
+
+      # Creates a plan on AcceptOn
+      #
+      # @api public
+      #
+      # @example Create a plan named "Test plan"
+      #   create_plan(name: 'Test Plan',
+      #               currency: 'usd',
+      #               amount: 20_00,
+      #               period_unit: 'year')
+      #
+      # @param args [Hash]
+      # @option args [String] :name The plan name.
+      # @option args [String] :currency The currency to be used, in ISO 4217 format.
+      # @option args [Numeric] :amount The plan amount.
+      # @option args [String] :period_unit The billing frequency unit, (in month or year only).
+      #
+      # @raise [AcceptOn::Error] If an API error happens
+      # @return [AcceptOn::Plan] The created plan
+      def create_plan(args = {})
+        perform_post_with_object('/v1/plans', args, AcceptOn::Plan)
+      end
+    end
+  end
+end

data/lib/accepton/api/querying.rb

@@ -11,7 +11,7 @@ module AcceptOn
       #
       # @param id [String] The charge identifier
       #
-      # @raises [AcceptOn::Error]
+      # @raise [AcceptOn::Error]
       # @return [AcceptOn::Charge]
       def charge(id)
         perform_get_with_object("/v1/charges/#{id}", {}, AcceptOn::Charge)
@@ -29,12 +29,71 @@ module AcceptOn
       # @option args [String] :order The order to sort by (asc or desc).
       # @option args [String] :order_by The field to order by (e.g. created_at).
       #
-      # @raises [AcceptOn::Error]
+      # @raise [AcceptOn::Error]
       # @return [AcceptOn::Charge]
       def charges(args = {})
         perform_get_with_objects('/v1/charges', args, AcceptOn::Charge)
       end
 
+      # Retrieves a plan from the API
+      #
+      # @api public
+      #
+      # @param id [String] The plan identifier
+      #
+      # @raise [AcceptOn::Error]
+      # @return [AcceptOn::Plan]
+      def plan(id)
+        perform_get_with_object("/v1/plans/#{id}", {}, AcceptOn::Plan)
+      end
+
+      # Retrieves a list of all plans from the API
+      #
+      # @api public
+      #
+      # @param args [Hash] A hash of query parameters
+      # @option args [String] :order The order to sort by (asc or desc).
+      # @option args [String] :order_by The field to order by (e.g. created_at).
+      # @option args [Integer] :page The page number to retrieve.
+      # @option args [Integer] :per_page The size of the page to retrieve (max: 100).
+      # @option args [String, Symbol] :period_unit The period unit to filter by.
+      #
+      # @raise [AcceptOn::Error]
+      # @return [AcceptOn::Plan]
+      def plans(args = {})
+        perform_get_with_objects('/v1/plans', args, AcceptOn::Plan)
+      end
+
+      # Retrieves a subscription from AcceptOn
+      #
+      # @api public
+      #
+      # @param id [String] The subscription identifier.
+      #
+      # @raise [AcceptOn::Error]
+      # @return [AcceptOn::Subscription]
+      def subscription(id)
+        perform_get_with_object("/v1/subscriptions/#{id}", {}, AcceptOn::Subscription)
+      end
+
+      # Retrieves a page of subscriptions from AcceptOn
+      #
+      # @api public
+      #
+      # @param args [Hash] A hash of query parameters
+      # @option args [String] :order The order to sort by (asc or desc).
+      # @option args [String] :order_by The field to order by (e.g. created_at).
+      # @option args [Integer] :page The page number to retrieve.
+      # @option args [Integer] :per_page The size of the page to retrieve (max: 100).
+      # @option args [Boolean] :active The activity status of the subscription to filter by.
+      # @option args [String] 'plan.token' The plan id of the subscription to filter by.
+      #
+      # @raise [AcceptOn::Error]
+      # @return [AcceptOn::Subscription>]
+      def subscriptions(args = {})
+        perform_get_with_objects('/v1/subscriptions', args, AcceptOn::Subscription)
+      end
+
       # Retrieves a promo code from AcceptOn
       #
       # @api public
@@ -76,7 +135,7 @@ module AcceptOn
       #
       # @param id [String] The transaction token identifier
       #
-      # @raises [AcceptOn::Error]
+      # @raise [AcceptOn::Error]
       # @return [AcceptOn::TransactionToken]
       def token(id)
         perform_get_with_object("/v1/tokens/#{id}", {}, AcceptOn::TransactionToken)

data/lib/accepton/api/subscribing.rb

@@ -0,0 +1,21 @@
+require 'accepton/api/utils'
+
+module AcceptOn
+  module API
+    module Subscribing
+      include AcceptOn::API::Utils
+
+      # Cancels a subscription on AcceptOn
+      #
+      # @api public
+      #
+      # @param id [String] The subscription identifier
+      #
+      # @raises [AcceptOn::Error]
+      # @return [AcceptOn::Subscription]
+      def cancel_subscription(id)
+        perform_post_with_object("/v1/subscriptions/#{id}/cancel", {}, AcceptOn::Subscription)
+      end
+    end
+  end
+end

data/lib/accepton/client.rb

@@ -1,13 +1,17 @@
+require 'accepton/api/planning'
 require 'accepton/api/promotion'
 require 'accepton/api/querying'
 require 'accepton/api/refunding'
+require 'accepton/api/subscribing'
 require 'accepton/api/tokenization'
 
 module AcceptOn
   class Client
+    include AcceptOn::API::Planning
     include AcceptOn::API::Promotion
     include AcceptOn::API::Querying
     include AcceptOn::API::Refunding
+    include AcceptOn::API::Subscribing
     include AcceptOn::API::Tokenization
 
     attr_accessor :api_key, :environment

data/lib/accepton/plan.rb

@@ -0,0 +1,21 @@
+module AcceptOn
+  class Plan < Base
+    # @attr_reader amount [Integer] The amount of the plan in cents
+    # @attr_reader currency [String] The ISO currency code of the refund
+    # @attr_reader id [String] The plan identifier
+    # @attr_reader name [String] The name of the plan
+    # @attr_reader period_unit [String] the billing frequency unit of the plan
+    #
+    # @api public
+    attr_reader :amount, :currency, :id, :name, :period_unit
+
+    # The time the plan was created
+    #
+    # @api public
+    #
+    # @return [Time]
+    def created_at
+      Time.parse(@created_at).utc unless @created_at.nil?
+    end
+  end
+end

data/lib/accepton/subscription.rb

@@ -0,0 +1,30 @@
+module AcceptOn
+  class Subscription < Base
+    # @attr_reader active [Boolean] The activity status of the subscription
+    # @attr_reader email [String] The email belonging to the subscription
+    # @attr_reader id [String] The subscription identifier
+    #
+    # @api public
+    attr_reader :active, :email, :id
+
+    alias_method :active?, :active
+
+    # The time the subscription was last billed
+    #
+    # @api public
+    #
+    # @return [Time]
+    def last_billed_at
+      Time.parse(@last_billed_at).utc unless @last_billed_at.nil?
+    end
+
+    # The plan the subscription is connected to
+    #
+    # @api public
+    #
+    # @return [AcceptOn::Plan]
+    def plan
+      AcceptOn::Plan.new(@plan)
+    end
+  end
+end

data/lib/accepton/version.rb

@@ -1,3 +1,3 @@
 module AcceptOn
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accepton
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - AcceptOn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -66,9 +66,11 @@ files:
 - Rakefile
 - accepton.gemspec
 - lib/accepton.rb
+- lib/accepton/api/planning.rb
 - lib/accepton/api/promotion.rb
 - lib/accepton/api/querying.rb
 - lib/accepton/api/refunding.rb
+- lib/accepton/api/subscribing.rb
 - lib/accepton/api/tokenization.rb
 - lib/accepton/api/utils.rb
 - lib/accepton/base.rb
@@ -76,9 +78,11 @@ files:
 - lib/accepton/client.rb
 - lib/accepton/error.rb
 - lib/accepton/headers.rb
+- lib/accepton/plan.rb
 - lib/accepton/promo_code.rb
 - lib/accepton/refund.rb
 - lib/accepton/request.rb
+- lib/accepton/subscription.rb
 - lib/accepton/transaction_token.rb
 - lib/accepton/version.rb
 homepage: https://developers.accepton.com