aptible-billforward 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea59a53fe3a5a639a6262239b4b467048239a932
+  data.tar.gz: 77e5113ccd920ae240202308ef5cbd66b4b50026
+SHA512:
+  metadata.gz: dedbbc99b242c9396376ef559fff7d48c01793a63fe7fb9bcfca0f7557f9b2d44a99724b9fb2d70784aa2a769fe4f25f4770c21e7019b02d7ee1f2bfdc39f129
+  data.tar.gz: 8de82401b7c813315a149c8d6e927c55b2108d05bd1945d7115bb08e6d1fd1632134530e6fa7e6b7e0069909e76b391534e0639dedadbbc2d12d9b40d388e1cc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aptible, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Procfile

@@ -0,0 +1 @@
+console: bundle exec pry -r aptible/billforward

data/README.md

@@ -0,0 +1,4 @@
+aptible-bf-ruby
+===============
+
+Ruby client for BillForward

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require 'aptible/tasks'
+Aptible::Tasks.load_tasks

data/aptible-billforward.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'English'
+require 'aptible/billforward/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aptible-billforward'
+  spec.version       = Aptible::BillForward::VERSION
+  spec.authors       = ['Skylar Anderson']
+  spec.email         = ['skylar@aptible.com']
+  spec.description   = 'Ruby client for BillForward.net'
+  spec.summary       = 'Ruby client for BillForward.net'
+  spec.homepage      = 'https://github.com/aptible/aptible-bf-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gem_config'
+  spec.add_dependency 'sawyer', '~> 0.5.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'aptible-tasks'
+  spec.add_development_dependency 'rake'
+end

data/lib/aptible/billforward/client.rb

@@ -0,0 +1,55 @@
+require 'sawyer'
+require 'aptible/billforward/serializer'
+
+module Aptible
+  module BillForward
+    class Client
+      include BillForward::Defaults
+      attr_reader :agent
+      attr_reader :last_response
+
+      def get(url, query = {})
+        request :get, url, nil, query: query
+      end
+
+      def post(url, resource, query = {})
+        request(:post, url, resource, query: query).first
+      end
+
+      def put(url, resource, query = {})
+        request :put, url, resource, query: query
+      end
+
+      def patch(url, resource, query = {})
+        request :patch, url, resource, query: query
+      end
+
+      def agent
+        @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+          http.headers[:accept] = media_type
+          http.headers[:user_agent] = user_agent
+          http.headers[:authorization] = "Bearer #{access_token}"
+        end
+      end
+
+      private
+
+      def sawyer_options
+        {
+          faraday: Faraday.new(connection_options),
+          serializer: Aptible::BillForward::Serializer.any_json
+        }
+      end
+
+      def request(method, path, data, options = {})
+        options[:headers] ||= {}
+        unless method == :get
+          options[:headers][:content_type] = 'application/json'
+        end
+
+        @last_response = agent.call(method, path, data, options)
+        @last_response.data
+      end
+    end
+  end
+end

data/lib/aptible/billforward/defaults.rb

@@ -0,0 +1,30 @@
+module Aptible
+  module BillForward
+    module Defaults
+      def access_token
+        Aptible::BillForward.configuration.access_token
+      end
+
+      def api_endpoint
+        Aptible::BillForward.configuration.root_url
+      end
+
+      def user_agent
+        "aptible-billforward Ruby Gem #{Aptible::BillForward::VERSION}"
+      end
+
+      def media_type
+        'application/json'
+      end
+
+      def connection_options
+        {
+          headers: {
+            accept: media_type,
+            user_agent: user_agent
+          }
+        }
+      end
+    end
+  end
+end

data/lib/aptible/billforward/exceptions.rb

@@ -0,0 +1,33 @@
+module Aptible
+  module BillForward
+    class Exception < ::StandardError
+      attr_accessor :cause
+
+      def initialize(message, attrs = {})
+        self.cause = attrs[:cause]
+        super(message)
+      end
+    end
+
+    class ResponseError < Exception
+      attr_accessor :response
+      attr_accessor :body
+
+      def initialize(message, attrs = {})
+        self.response = attrs[:response]
+        self.body = attrs[:body]
+
+        if body.present? && body.key?(:errorMessage)
+          error = body[:errorMessage]
+          message = "#{message} (#{error})"
+        elsif response
+          message = "#{message} (\"#{response.inspect}\")"
+        end
+
+        super(message, attrs)
+      end
+    end
+
+    class ResourceNotFoundError < ResponseError; end
+  end
+end

data/lib/aptible/billforward/resource/account.rb

@@ -0,0 +1,39 @@
+module Aptible
+  module BillForward
+    class Account < Resource
+      def serialize
+        to_attrs
+      end
+
+      def create_payment_method(params)
+        Aptible::BillForward::PaymentMethod.create(
+          params.merge(accountID: id)
+        )
+      end
+
+      def create_subscription(params)
+        Aptible::BillForward::Subscription.create(
+          params.merge(accountID: id)
+        )
+      end
+
+      def payment_methods(params = {})
+        Aptible::BillForward::PaymentMethod.by_account_id(id, params)
+      end
+
+      def subscriptions(params = {})
+        Aptible::BillForward::Subscription.by_account_id(id, params)
+      end
+
+      def bootstrap_active_subscription(params)
+        subscription = create_subscription params.slice(:productRatePlanID)
+        payment_method = Aptible::BillForward::PaymentMethod.find(
+          params[:payment_method_id]
+        )
+
+        subscription.link_payment_method payment_method
+        subscription.update(state: 'AwaitingPayment')
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource/invoice.rb

@@ -0,0 +1,6 @@
+module Aptible
+  module BillForward
+    class Invoice < Resource
+    end
+  end
+end

data/lib/aptible/billforward/resource/payment_method.rb

@@ -0,0 +1,17 @@
+module Aptible
+  module BillForward
+    class PaymentMethod < Resource
+      def self.basename
+        'payment-methods'
+      end
+
+      def serialize
+        to_attrs
+      end
+
+      def self.by_account_id(account_id, params = {})
+        client.get "#{collection_path}/account/#{account_id}", params
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource/payment_method_subscription_link.rb

@@ -0,0 +1,9 @@
+module Aptible
+  module BillForward
+    class PaymentMethodSubscriptionLink < Resource
+      def serialize
+        to_attrs
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource/product_rate_plan.rb

@@ -0,0 +1,17 @@
+module Aptible
+  module BillForward
+    class ProductRatePlan < Resource
+      def self.basename
+        'product-rate-plans'
+      end
+
+      def serialize
+        to_attrs
+      end
+
+      def self.by_account_id(account_id, params = {})
+        client.get "#{collection_path}/account/#{account_id}", params
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource/subscription.rb

@@ -0,0 +1,45 @@
+module Aptible
+  module BillForward
+    class Subscription < Resource
+      def serialize
+        to_attrs
+      end
+
+      def usage_periods(_params = {})
+        @usage_periods ||=
+        Aptible::BillForward::UsagePeriod.by_subscription_id(id)
+      end
+
+      def usage_sessions(_params = {})
+        @usage_sessions ||=
+        Aptible::BillForward::UsageSession.by_subscription_id(id)
+      end
+
+      def usage(_params = {})
+        @usage ||= Aptible::BillForward::Usage.by_subscription_id(id)
+      end
+
+      def create_usage_session(params = {})
+        usage_params = params.merge(
+          subscriptionID: id,
+          sessionID: Aptible::BillForward::UsageSession.generate_session_id
+        )
+        Aptible::BillForward::UsageSession.create(usage_params)
+      end
+
+      def link_payment_method(payment_method)
+        Aptible::BillForward::PaymentMethodSubscriptionLink.create(
+          subscriptionID: id, paymentMethodID: payment_method.id
+        )
+      end
+
+      def self.by_account_id(account_id, params = {})
+        client.get "#{collection_path}/account/#{account_id}", params
+      end
+
+      def href
+        "#{self.class.collection_path}"
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource/units_of_measure.rb

@@ -0,0 +1,9 @@
+module Aptible
+  module BillForward
+    class UnitOfMeasure < Resource
+      def self.basename
+        'units-of-measure'
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource/usage.rb

@@ -0,0 +1,13 @@
+module Aptible
+  module BillForward
+    class Usage < Resource
+      def self.basename
+        'usage'
+      end
+
+      def self.create(params)
+        client.post "#{collection_path}/create", new(client.agent, params)
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource/usage_period.rb

@@ -0,0 +1,6 @@
+module Aptible
+  module BillForward
+    class UsagePeriod < Resource
+    end
+  end
+end

data/lib/aptible/billforward/resource/usage_session.rb

@@ -0,0 +1,32 @@
+require 'securerandom'
+
+module Aptible
+  module BillForward
+    class UsageSession < Resource
+      def self.find(subscriptionID, sessionID)
+        by_subscription_id(subscriptionID).find do |session|
+          session.sessionID == sessionID
+        end
+      end
+
+      def self.create(params)
+        client.post "#{collection_path}/start", new(client.agent, params)
+      end
+
+      def self.stop(params)
+        client.post "#{collection_path}/stop", new(client.agent, params)
+      end
+
+      def self.generate_session_id
+        SecureRandom.uuid
+      end
+
+      def create_usage(usage_params)
+        usage = usage_params.merge(
+          to_attrs.slice(:organizationID, :subscriptionID, :sessionID, :uom)
+        )
+        Aptible::BillForward::Usage.create usage
+      end
+    end
+  end
+end

data/lib/aptible/billforward/resource.rb

@@ -0,0 +1,80 @@
+require 'aptible/billforward/response'
+
+module Aptible
+  module BillForward
+    class Resource < Sawyer::Resource
+      def self.all(query = {})
+        client.get collection_path, query: query
+      end
+
+      def self.find(id)
+        client.get("#{collection_path}/#{id}").first
+      end
+
+      def self.create(params, query = {})
+        client.post collection_path, new(client.agent, params), query: query
+      end
+
+      def self.collection_path
+        basename
+      end
+
+      def update(params)
+        self.attrs = attrs.merge(params)
+        client.put href, self
+      end
+
+      def href
+        "#{self.class.collection_path}/#{id}"
+      end
+
+      def self.basename
+        name.split('::').last.underscore.dasherize.pluralize
+      end
+
+      def self.client
+        @client ||= Aptible::BillForward::Client.new
+      end
+
+      def client
+        @client ||= Aptible::BillForward::Client.new
+      end
+
+      def invoice
+        return nil unless invoiceID
+        Aptible::BillForward::Invoice.find(invoiceID)
+      end
+
+      def subscription
+        return nil unless subscriptionID
+        Aptible::BillForward::Subscription.find(subscriptionID)
+      end
+
+      def self.by_subscription_id(subscription_id, options = {})
+        state = options[:active] ? '/active' : ''
+        client.get(
+          "#{collection_path}/#{subscription_id}#{state}",
+          order: 'DESC', order_by: 'start'
+        )
+      end
+
+      def serialize
+        type = self.class.basename.underscore.camelize(:lower).pluralize
+        body = {}
+        body[type] = [to_attrs]
+        body
+      end
+    end
+  end
+end
+
+require 'aptible/billforward/resource/account'
+require 'aptible/billforward/resource/invoice'
+require 'aptible/billforward/resource/payment_method'
+require 'aptible/billforward/resource/payment_method_subscription_link'
+require 'aptible/billforward/resource/product_rate_plan'
+require 'aptible/billforward/resource/subscription'
+require 'aptible/billforward/resource/usage'
+require 'aptible/billforward/resource/units_of_measure'
+require 'aptible/billforward/resource/usage_period'
+require 'aptible/billforward/resource/usage_session'

data/lib/aptible/billforward/response.rb

@@ -0,0 +1,45 @@
+require 'logger'
+require 'aptible/billforward/exceptions'
+
+module Sawyer
+  class Response
+    # rubocop:disable MethodLength
+    def initialize(agent, res, options = {})
+      fail Aptible::BillForward::ResponseError.new(
+        @status.to_s,
+        response: @res,
+        body: @data,
+        cause: @status
+      ) if res.status >= 400
+
+      @res = res
+      @agent = agent
+      @status = res.status
+      @headers = res.headers
+      @env = res.env
+      @rels = process_rels
+      @started = options[:sawyer_started]
+      @ended = options[:sawyer_ended]
+      @data = if @headers[:content_type] =~ /json|msgpack/
+                process_data(@agent.decode_body(res.body))
+              else
+                res.body
+              end
+    end
+    # rubocop:enable MethodLength
+
+    def process_data(data)
+      data = data[:results] if data.key? :results
+      case data
+      when Hash  then klass_from_type(data).new(agent, data)
+      when Array then data.map { |hash| process_data(hash) }
+      when nil   then nil
+      else data
+      end
+    end
+
+    def klass_from_type(result)
+      "Aptible::BillForward::#{result[:@type].classify}".constantize
+    end
+  end
+end

data/lib/aptible/billforward/serializer.rb

@@ -0,0 +1,20 @@
+module Aptible
+  module BillForward
+    class Serializer < Sawyer::Serializer
+      def encode_object(resource)
+        return resource.serialize if resource.respond_to? :serialize
+        case resource
+        when Hash then encode_hash(resource)
+        when Array then resource.map { |o| encode_object(o) }
+        else resource
+        end
+      end
+
+      def time_field?(key, value)
+        time_fields = %w(created updated start stop initalPeriodStart
+                         currentPeriodStart currentPeriodEnd)
+        value && time_fields.include?(key)
+      end
+    end
+  end
+end

data/lib/aptible/billforward/version.rb

@@ -0,0 +1,5 @@
+module Aptible
+  module BillForward
+    VERSION = '0.0.1'
+  end
+end

data/lib/aptible/billforward.rb

@@ -0,0 +1,21 @@
+require 'gem_config'
+require 'aptible/billforward/defaults'
+
+module Aptible
+  module BillForward
+    include GemConfig::Base
+
+    with_configuration do
+      has :root_url,
+          classes: String,
+          default: ENV['BILLFORWARD_ROOT_URL'] || 'https://api.billforward.net'
+
+      has :access_token,
+          classes: String,
+          default: ENV['BILLFORWARD_ACCESS_TOKEN'] || ''
+    end
+  end
+end
+
+require 'aptible/billforward/client'
+require 'aptible/billforward/resource'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: aptible-billforward
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skylar Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aptible-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for BillForward.net
+email:
+- skylar@aptible.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.md
+- Procfile
+- README.md
+- Rakefile
+- aptible-billforward.gemspec
+- lib/aptible/billforward.rb
+- lib/aptible/billforward/client.rb
+- lib/aptible/billforward/defaults.rb
+- lib/aptible/billforward/exceptions.rb
+- lib/aptible/billforward/resource.rb
+- lib/aptible/billforward/resource/account.rb
+- lib/aptible/billforward/resource/invoice.rb
+- lib/aptible/billforward/resource/payment_method.rb
+- lib/aptible/billforward/resource/payment_method_subscription_link.rb
+- lib/aptible/billforward/resource/product_rate_plan.rb
+- lib/aptible/billforward/resource/subscription.rb
+- lib/aptible/billforward/resource/units_of_measure.rb
+- lib/aptible/billforward/resource/usage.rb
+- lib/aptible/billforward/resource/usage_period.rb
+- lib/aptible/billforward/resource/usage_session.rb
+- lib/aptible/billforward/response.rb
+- lib/aptible/billforward/serializer.rb
+- lib/aptible/billforward/version.rb
+homepage: https://github.com/aptible/aptible-bf-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for BillForward.net
+test_files: []