balanced 0.8.2 → 1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e6ae6caeed95c470b53d19fc6129e52f7e6cbc7
-  data.tar.gz: 7582cfec0cbd38c8f3004ce3b4b8f4023494a351
+  metadata.gz: 66a60458d86bd0fe40aeb014e233fddeca12d627
+  data.tar.gz: 486418ed6ee7bac939ec7dcb6a036bebb3ef861c
 SHA512:
-  metadata.gz: 4c75ab6b88d261cd793c20dddb5ac9f14075d00ba79b6cb0b47173824f742894485b192c1f37db785c5d3f374db80cb895a4a01dcd34fbd584a5be4b2c7daf8f
-  data.tar.gz: 24720c53dd846507124a89611a4f06c16e3e6e4e94894f412fc1930ca356c5b958be273eff010dfff62c762cfb0c5836a671c491e2adf63ed19ab7f3a71bc94c
+  metadata.gz: fb2dbf84c8740fde03b2cacd09b0a8b2b4a39613e7cb60862f78cb8907cad67f9cc1af5a8ec79215fc8c7edae3992c4fd50fbae2c8b243b0ee91034701d76091
+  data.tar.gz: a92899108421c79d1353e72c2fa2411f082158116a03ebe24b7fff4b0ea8bb5bd21cc7b1d2dbcc41433d218586f83439fad26f35fba15bbf2f9d8500cf660fb0

data/.rbenv-version

@@ -1 +1 @@
-1.9.2-p290
+1.9.3-p194

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+1.8.7-p370

data/Gemfile

@@ -2,17 +2,21 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in balanced.gemspec
 
-gemspec
+gem "faraday"
+gem "faraday_middleware"
+gem "addressable"
+gem "json"
 
 group :development do
   gem "yard"
   gem "guard", '~> 1.6.2'
+  gem "listen", "~> 1.3.1" # 2.x requires celluloid, not 1.8.7 friendly
   gem "guard-rspec", '~> 2.4.1'
 end
 
 group :test do
   gem 'net-http-persistent'
-  gem "rspec", '~> 2.13.0'
+  gem "rspec", '~> 2.14.1'
   gem "rake", '~> 10.0.3'
   gem "vcr", '~> 2.4.0'
-end
+end

data/README.md

@@ -21,9 +21,9 @@ Or install it yourself as:
 
 ## Documentation & Usage
 
-* [Balanced Overview](https://www.balancedpayments.com/docs/overview?language=ruby)
+* [Balanced Overview](https://docs.balancedpayments.com/?language=ruby)
 * [RDoc](http://rubydoc.info/gems/balanced)
-* [Balanced API with Ruby examples](https://www.balancedpayments.com/docs/api?language=ruby)
+* [Balanced API with Ruby examples](https://docs.balancedpayments.com/api?language=ruby)
 * [Example scripts](https://github.com/balanced/balanced-ruby/tree/master/examples)
 
 ## Contributing
@@ -64,14 +64,6 @@ All issues should be documented at
 [balanced-ruby/issues](https://github.com/balanced/balanced-ruby/issues)
 
 
-### Building Documentation
-
-Documentation is built using YARD - http://rubydoc.info/docs/yard
-
-    export AMAZON_ACCESS_KEY_ID='xxx'
-    export AMAZON_SECRET_ACCESS_KEY='yyy'
-    ./upload_docs.rb
-
 ### Scenarios
 
 ####Render

data/Rakefile

@@ -6,24 +6,10 @@ require "bundler/gem_tasks"
 require 'rspec'
 
 desc "Run spec suite"
-RSpec::Core::RakeTask.new(:spec) { |t| }
+RSpec::Core::RakeTask.new(:spec) do |task|
+  file_list = FileList['spec/**/*_spec.rb']
+  task.pattern = file_list
+end
 
 desc "Default the task to run the spec"
 task :default => [:spec]
-
-desc "Render template files"
-task :render_executables do
-  ruby File.dirname(__FILE__) + "/scenarios/render.rb"
-end
-
-desc "delete executables"
-task :delete_executables do
-  ruby File.dirname(__FILE__) + "/scenarios/delete.rb"
-end
-
-desc "render one template file"
-task :render_one, :name do
-  name = ENV['NAME']
-  file = File.dirname(__FILE__) + "/scenarios/render_one.rb"
-  ruby file, name
-end

data/balanced.gemspec

@@ -4,17 +4,15 @@ require "base64"
 require File.expand_path('../lib/balanced/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Mahmoud Abdelkader"]
-  gem.email         = ["bWFobW91ZEBwb3VuZHBheS5jb20="].map { |i| Base64.decode64(i) }
-  gem.description   = %q{Balanced is the payments platform for marketplaces.
-    Integrate a payments experience just like Amazon for your marketplace.
-    Forget about dealing with banking systems, compliance, fraud, and security.
-    }
-  gem.summary       = %q{Sign up on https://balancedpayments.com/}
-  gem.homepage      = "https://balancedpayments.com"
+  gem.authors       = ["Balanced"]
+  gem.email         = ["ZGV2QGJhbGFuY2VkcGF5bWVudHMuY29t"].map { |i| Base64.decode64(i) }
+  gem.description   = %q{Balanced is the payments platform for marketplaces.    }
+  gem.summary       = %q{https://docs.balancedpayments.com/}
+  gem.homepage      = "https://www.balancedpayments.com"
 
-  gem.add_dependency("faraday", '~> 0.8.6')
+  gem.add_dependency("faraday", '>= 0.8.6')
   gem.add_dependency("faraday_middleware", '~> 0.9.0')
+  gem.add_dependency("addressable", '~> 2.3.5')
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -22,4 +20,4 @@ Gem::Specification.new do |gem|
   gem.name          = "balanced"
   gem.require_paths = %w(lib)
   gem.version       = Balanced::VERSION
-end
+end

data/lib/balanced.rb

@@ -5,7 +5,6 @@ require 'uri'
 require 'balanced/version' unless defined? Balanced::VERSION
 require 'balanced/client'
 require 'balanced/utils'
-require 'balanced/resources'
 require 'balanced/error'
 
 module Balanced
@@ -13,16 +12,18 @@ module Balanced
   @client = nil
   @config = {
       :scheme => 'https',
-
       :host => 'api.balancedpayments.com',
       :port => 443,
-      :version => '1',
+      :version => '1.1',
   }
 
+  @hypermedia_registry = {}
+
   class << self
 
     attr_accessor :client
     attr_accessor :config
+    attr_accessor :hypermedia_registry
 
     def configure(api_key=nil, options={})
       @config = @config.merge(options)
@@ -33,34 +34,29 @@ module Balanced
       !@client.api_key.nil?
     end
 
-    def split_the_uri uri
-      URI.parse(uri).path.sub(/\/$/, '').split('/')
+    def split_the_href(href)
+      URI.parse(href).path.sub(/\/$/, '').split('/')
     end
 
-    def from_uri uri
-      split_uri = split_the_uri(uri)
-      # this is such an ugly hack, basically, we're trying to
-      # see if we have the symbol that matches the capitalized
-      #
-      class_name = Balanced::Utils.classify(split_uri[-1])
-      begin
-        klass = Balanced.const_get class_name
-      rescue NameError
-        class_name = Utils.classify(split_uri[-2])
-        klass = Balanced.const_get(class_name)
+    def from_hypermedia_registry(resource_name)
+      cls = Balanced.hypermedia_registry[resource_name]
+      if cls.nil?
+        raise 'OH SHIT'
       end
-      klass
+      cls
     end
 
-    def is_collection uri
-      split_uri = split_the_uri(uri)
-      class_name = Balanced::Utils.classify(split_uri[-1])
-      begin
-        Balanced.const_get class_name
-      rescue NameError
-        return false
+    def from_href(href)
+      split_uri = split_the_href(href)
+      split_uri.reverse!.each do |resource|
+        cls = Balanced.hypermedia_registry[resource]
+        return cls unless cls.nil?
       end
-      true
+    end
+
+    def is_collection(href)
+      split_uri = split_the_href(href)
+      Balanced.hypermedia_registry.has_key?(split_uri.last)
     end
 
     def get(*args, &block)
@@ -75,13 +71,17 @@ module Balanced
       self.client.put *args
     end
 
-    def delete(*args, &block)
-      self.client.delete *args
+    def unstore(*args, &block)
+      self.client.unstore *args
     end
-
+    alias_method :delete, :unstore
   end
 
   # configure on import so we don't have to configure for creating
   # an api key
   configure
 end
+
+# require all the balanced resources! this is needed at the end because
+# the Balanced module needs to be defined first, as it contains the registry
+require 'balanced/resources'

data/lib/balanced/client.rb

@@ -1,8 +1,8 @@
-require "logger"
-require "uri"
-require "faraday"
-require "faraday_middleware"
-require "balanced_exception_middleware"
+require 'logger'
+require 'uri'
+require 'faraday'
+require 'faraday_middleware'
+require 'balanced_exception_middleware'
 
 
 module Balanced
@@ -18,7 +18,8 @@ module Balanced
       :read_timeout => 60,
       :logger => nil,
       :ssl_verify => true,
-      :faraday_adapter => Faraday.default_adapter
+      :faraday_adapter => Faraday.default_adapter,
+      :accept_type => 'application/vnd.api+json'
     }
 
     attr_reader :conn
@@ -61,6 +62,8 @@ module Balanced
       end
       conn.path_prefix = '/'
       conn.headers['User-Agent'] = "balanced-ruby/#{Balanced::VERSION}"
+      conn.headers['Content-Type'] = "application/json;revision=#{@config[:version]}"
+      conn.headers['Accept'] = "#{@config[:accept_type]};revision=#{@config[:version]}"
     end
 
     #def inspect  # :nodoc:
@@ -75,6 +78,12 @@ module Balanced
                      :scheme => config[:scheme]})
     end
 
+    # alias_method doesn't work with method_missing, so we manually
+    # delegate
+    def unstore(*args, &block)
+      delete(*args, &block)
+    end
+
     def method_missing(method, *args, &block)
       if is_http_method? method
         conn.basic_auth(api_key, '') unless api_key.nil?

data/lib/balanced/error.rb

@@ -14,25 +14,33 @@ module Balanced
     def body
       @body ||= begin
         return {} unless response[:body]
-        Utils.hash_with_indifferent_read_access(response[:body])
+        Utils.indifferent_read_access(response[:body])
       end
     end
 
     def error_message
       set_attrs
-      extra = body[:additional] ? " -- #{body[:additional]}" : ""
-      "#{self.class.name}(#{response[:status]})::#{body[:status]}:: "\
-      "#{response[:method].to_s.upcase} #{response[:url].to_s}: "\
-      "#{body[:category_code]}: #{body[:description]} #{extra}"
+      errors = body.fetch('errors', nil)
+      unless errors.nil?
+        error = body[:errors][0]
+        extra = error[:additional] ? " -- #{error[:additional]}" : ""
+        "#{self.class.name}(#{response[:status]})::#{error[:status]}:: "\
+        "#{response[:method].to_s.upcase} #{response[:url].to_s}: "\
+        "#{error[:category_code]}: #{error[:description]} #{extra}"
+      end
     end
 
     private
     def set_attrs
-      body.keys.each do |name|
-        self.class.instance_eval {
-          define_method(name) { body[name] }                       # Get.
-          define_method("#{name}?") { !!body[name] }               # Present.
-        }
+      errors = body.fetch('errors', nil)
+      unless errors.nil?
+        error = errors[0]
+        error.keys.each do |name|
+          self.class.instance_eval {
+            define_method(name) { error[name] }                       # Get.
+            define_method("#{name}?") { !!error[name] }               # Present.
+          }
+        end
       end
     end
   end
@@ -49,7 +57,8 @@ module Balanced
     end
   end
 
-  # Raised when attempted to create a debit or hold for a card not associated to an account
+  # Raised when attempted to create a debit or hold for a card not associated
+  # to a customer.
   class UnassociatedCardError < StandardError
     # @param [Balanced::Card] card
     def initialize(card)
@@ -58,7 +67,7 @@ module Balanced
     end
 
     def error_message
-      "The Balanced::Card with uri=#{@card.attributes['uri']} is not associated to an account"
+      "The Balanced::Card with uri=#{@card.attributes['uri']} is not associated to a customer"
     end
   end
 

data/lib/balanced/pager.rb

@@ -7,6 +7,9 @@ module Balanced
 
     include Enumerable
 
+    attr_accessor :href
+    attr_accessor :options
+
     # A pager for paginating through resource records.
     #
     # @param [String] uri the uri of the resource
@@ -14,8 +17,8 @@ module Balanced
     # @option options [Integer] limit
     # @option options [Integer] offset
     # @option options [Integer] per an alias for the :limit option
-    def initialize uri, options = {}
-      @uri = uri
+    def initialize(href, options = {})
+      @href = href
       @options = options
       @page = nil
       @resource_class = nil
@@ -24,34 +27,47 @@ module Balanced
     def resource_class
       return @resource_class unless @resource_class.nil?
       load! unless @page
-      @resource_class = Balanced.from_uri items.first[:uri]
+      @resource_class
     end
 
     def first
       load! unless @page
-      items.first.nil? ? nil : resource_class.construct_from_response(items.first)
+      if items.first.nil?
+        nil
+      else
+        envelope = {
+          :meta => @page[:meta],
+          :links => @page[:links],
+          @resource_class.collection_name.to_sym => [items.first]
+        }
+        resource_class.construct_from_response(envelope)
+      end
     end
 
     def total
       load! unless @page
-      @page[:total]
+      @page[:meta][:total]
     end
 
     def limit
       load! unless @page
-      @page[:limit]
+      @page[:meta][:limit]
     end
     alias limit_value limit
 
     def offset
       load! unless @page
-      @page[:offset]
+      @page[:meta][:offset]
     end
     alias offset_value offset
 
     def items
       load! unless @page
-      @page[:items]
+      if @resource_class.nil?
+        []
+      else
+        @page[@resource_class.collection_name]
+      end
     end
 
     def current_page
@@ -71,19 +87,24 @@ module Balanced
 
       load! unless @page
       loop do
-        @page[:items].each do |r|
-          yield resource_class.construct_from_response r
+        items.each do |r|
+          envelope = {
+            :meta => @page[:meta],
+            :links => @page[:links],
+            @resource_class.collection_name.to_sym => [r]
+          }
+          yield resource_class.construct_from_response(envelope)
         end
-        raise StopIteration if @page[:next_uri].nil?
+        raise StopIteration if @page[:meta][:next].nil?
         self.next
       end
     end
 
     # @return [nil]
-    # @see Resource.find_each
+    # @see Resource.fetch_each
     # @yield [record]
-    def find_each
-      return enum_for :find_each unless block_given?
+    def fetch_each
+      return enum_for :fetch_each unless block_given?
       begin
         each { |record| yield record }
       end while self.next
@@ -93,7 +114,7 @@ module Balanced
     #   the next page.
     def next
       load! unless @page
-      next_uri = @page[:next_uri]
+      next_uri = @page[:meta][:next]
       load_from next_uri, nil unless next_uri.nil?
     end
 
@@ -101,7 +122,7 @@ module Balanced
     #   the previous page.
     def prev
       load! unless @page
-      prev_uri = @page[:prev_uri]
+      prev_uri = @page[:meta][:prev]
       load_from prev_uri, nil unless prev_uri.nil?
     end
 
@@ -109,21 +130,21 @@ module Balanced
     #   the first page.
     def start
       load! unless @page
-      first_page = @page[:first_page]
+      first_page = @page[:meta][:first]
       load_from first_page, nil unless first_page.nil?
     end
 
     # @return [Array, nil] Load (or reload) the pager's collection from the
     #   original, supplied options.
     def load!
-      load_from @uri, @options
+      load_from @href, @options
     end
     alias reload load!
 
     # @return [Pager] Duplicates the pager, updating it with the options
     #   supplied. Useful for resource scopes.
     # @see #initialize
-    def paginate options = {}
+    def paginate(options = {})
       dup.instance_eval {
         @page = nil
         @options.update options and self
@@ -132,23 +153,35 @@ module Balanced
     alias scoped paginate
     alias where  paginate
 
-    def all options = {}
+    def all(options = {})
       paginate(options).to_a
     end
 
-    def find uri
+    def fetch(uri)
       if resource_class.respond_to? :find
         raise NoMethodError,
             "#find must be called on #{resource_class} directly"
       end
 
-      resource_class.find uri
+      resource_class.fetch uri
+    end
+
+    def create(options={})
+      opts = Balanced::Utils.indifferent_read_access options
+      opts[:href] = @href
+      # if we don't have a media type for the href,
+      # let's try to inspect the url to look it up from the
+      # registry
+      if @resource_class.nil?
+        @resource_class = Balanced.from_href(@href)
+      end
+      @resource_class.new(opts).save
     end
 
 
     private
 
-    def load_from uri, params
+    def load_from(uri, params)
       parsed_uri = URI.parse(uri)
 
       params ||= {}
@@ -167,8 +200,16 @@ module Balanced
       end
 
       response = Balanced.get parsed_uri.to_s, params
-      @page = Balanced::Utils.hash_with_indifferent_read_access response.body
-      @uri = @page[:uri]
+      @page = Balanced::Utils.indifferent_read_access response.body
+
+      @href = @page[:meta][:href]
+      # resource_class?
+      hypermedia_key = (@page.keys.map{|k| k.to_sym } - [:meta, :links]).first
+      unless hypermedia_key.nil?
+        @resource_class = Balanced.from_hypermedia_registry(hypermedia_key.to_s)
+      end
+
+      @page
     end
 
     def adjust_pagination_params(original)