balanced 0.1.0 → 0.2.0

data/.gitignore

@@ -20,3 +20,6 @@ doc/
 # env
 .idea
 werk
+
+# lib
+Gemfile.lock

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in balanced.gemspec
 gemspec
+gem "rake"
+gem "rspec", '~> 2.0'
+gem "faraday", '~> 0.8'
+gem "faraday_middleware", '~> 0.8.7'
+

data/Rakefile

@@ -1,2 +1,10 @@
 #!/usr/bin/env rake
+require "rake"
+require "rspec/core/rake_task"
 require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+

data/balanced.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/balanced/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Mahmoud Abdelkader"]
-  gem.email         = ["mahmoud@poundpay.com"]
+  gem.email         = %w(mahmoud@poundpay.com)
   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.
@@ -15,6 +15,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "balanced"
-  gem.require_paths = ["lib"]
+  gem.require_paths = %w(lib)
   gem.version       = Balanced::VERSION
 end

data/examples/examples.rb

@@ -0,0 +1,47 @@
+
+# create our new api key
+api_key = Balanced::ApiKey.new.save
+puts "Our secret is: ", api_key
+
+# configure with our secret
+Balanced.configure(api_key.secret)
+
+# create our marketplace
+marketplace = Balanced::Marketplace.new.save
+
+card = Balanced::Card.new(
+  :card_number => "5105105105105100",
+  :expiration_month => "12",
+  :expiration_year => "2015",
+).save
+
+# create our account
+buyer = marketplace.create_buyer(
+    :email_address => "buyer@example.org",
+    :card_uri => card.uri
+)
+
+# hold some amount of funds on the buyer, lets say 15$
+the_hold = buyer.hold(
+    :amount => 1500,
+)
+
+# the hold has a fee of 35c
+assert the_hold.fee == 35
+
+# nah, lets just debit it
+debit = the_hold.debit()
+
+# hmm, how much money do i have in escrow? should equal
+# the debit amount
+marketplace = marketplace.find(marketplace.uri)
+assert marketplace.in_escrow == 1500
+
+
+# cool. now let me refund
+refund = debit.refund()  # the full amount!
+
+# notice how Balanced refunds you your fees?
+assert (refund.fee + debit.fee) == 0
+
+

data/lib/balanced.rb

@@ -1 +1,81 @@
-require 'balanced/version' unless defined? Balanced::VERSION
+require 'uri'
+require 'balanced/version' unless defined? Balanced::VERSION
+
+module Balanced
+  autoload :Client, 'balanced/client'
+  autoload :Utils, 'balanced/utils'
+  autoload :Resource, 'balanced/base'
+  autoload :ApiKey, 'balanced/resources'
+  autoload :Marketplace, 'balanced/resources'
+
+  @client = nil
+  @config = {
+      :scheme => 'http',
+      :host => 'localhost',
+      :port => 5000,
+      :version => '1',
+  }
+
+  class << self
+
+    attr_accessor 'client'
+    attr_accessor 'config'
+
+    def configure(api_key=nil, options={})
+      options = @config.merge! options
+      @config = options
+      @client = Balanced::Client.new(api_key, @config)
+    end
+
+    def get uri, params = {}
+      self.client.get uri, params
+    end
+
+    def post uri, data = {}
+      self.client.post uri, data
+    end
+
+    def put uri, data = {}
+      self.client.put uri, data
+    end
+
+    def delete uri
+      self.client.delete uri
+    end
+
+    def split_the_uri uri
+      parsed_uri = URI.parse(uri)
+      parsed_uri.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)
+      end
+      klass
+    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
+        false
+      end
+      true
+    end
+  end
+
+  # configure on import so we don't have to configure for creating
+  # an api key
+  configure
+end

data/lib/balanced/base.rb

@@ -0,0 +1,123 @@
+module Balanced
+  class Resource
+
+    class << self
+
+      def resource_name
+        Utils.demodulize name
+      end
+
+      def collection_name
+        Utils.pluralize Utils.underscore(resource_name)
+      end
+
+      def collection_path
+        ["/v#{Balanced.config[:version]}", collection_name].compact.join '/'
+      end
+
+      def member_name
+        Utils.underscore resource_name
+      end
+
+    end
+
+    attr_reader :attributes
+
+    def initialize attributes = {}
+      @attributes = attributes
+      self.attributes = attributes
+    end
+
+    def attributes= attributes = {}
+      attributes.each_pair { |k, v|
+        respond_to?(name = "#{k}=") and send(name, v) or (self[k] = v)
+      }
+    end
+
+    def read_attribute key
+      attributes[key.to_s]
+    end
+    alias [] read_attribute
+
+    def write_attribute key, value
+      attributes[key] = value
+    end
+    alias []= write_attribute
+
+    # delegate the query to the pager module
+
+    def find (uri, options={})
+      payload = Balanced.get :uri => uri
+      construct_from_response payload
+    end
+
+    def save
+      uri = self.attributes.delete('uri') { |key| nil }
+      method = :post
+      if uri.nil?
+        uri = self.class.collection_path
+      else
+        method = :put
+      end
+      response = Balanced.send(method, uri, self.attributes)
+      reload response
+    end
+
+    def destroy
+      Balanced.delete :uri => self.attributes['uri']
+    end
+
+    def construct_from_response payload
+      klass = Balanced.from_uri(payload['uri'])
+      instance = klass.new payload
+      payload.each do |name, value|
+        klass.class_eval {
+          attr_accessor name.to_s
+        }
+        # here is where our interpretations will begin.
+        # if the value is a sub-resource, lets instantiate the class
+        # and set it correctly
+        if value.instance_of? Hash and value.has_key? 'uri'
+          value = construct_from_response value
+        elsif name =~ /_uri$/
+          modified_name = name.sub(/_uri$/, '')
+          klass.instance_eval {
+            define_method(modified_name) {
+              values_class = Balanced.from_uri(value)
+              # if uri is a collection -> this would definitely be if it ends in a symbol
+              # then we should allow a lazy executor of the query pager
+              if Balanced.is_collection(value)
+                # TODO: return the pager
+                p "TODO: return the pager for this class: #{values_class}"
+                values_class.new
+              else
+                values_class.find(value)
+              end
+            }
+          }
+        end
+
+        instance.instance_variable_set "@#{name}", value
+      end
+      instance
+    end
+
+    def reload response = nil
+      if response
+        return if response.body.to_s.length.zero?
+        fresh = self.construct_from_response response.body
+      else
+        fresh = self.find(@attributes['uri'])
+      end
+      fresh and copy_from fresh
+      self
+    end
+
+    def copy_from other
+      other.instance_variables.each do |ivar|
+        instance_variable_set ivar, other.instance_variable_get(ivar)
+      end
+    end
+
+  end
+end

data/lib/balanced/client.rb

@@ -0,0 +1,83 @@
+require "uri"
+require "faraday"
+require "faraday_middleware"
+
+module Balanced
+  class Client
+
+    HTTP_HEADERS = {
+       'Accept' => 'application/json',
+       'Accept-Charset' => 'utf-8',
+       'User-Agent' => "balanced-ruby/#{Balanced::VERSION}",
+    }
+
+    DEFAULTS = {
+      :scheme => 'http',
+      :host => 'localhost',
+      :port => 5000,
+      :version => '1',
+    }
+
+    attr :api_key, true
+    attr_reader :conn
+    attr_accessor :config
+
+    def initialize(api_key, options={})
+      @api_key = api_key.nil? ? api_key : api_key.strip
+      @config = DEFAULTS.merge! options
+      build_conn
+    end
+
+
+    def build_conn
+      @conn = Faraday.new url do |cxn|
+        cxn.request  :json
+
+        cxn.response :logger
+        cxn.response :json
+        cxn.adapter  Faraday.default_adapter
+      end
+      @conn.path_prefix = '/'
+    end
+
+    def inspect  # :nodoc:
+      "<Balanced::Client @api_key=#{@api_key}, @url=#{url}>"
+    end
+
+    def url
+      URI::HTTP.build(
+          :scheme => @config[:scheme],
+          :host => @config[:host],
+          :port => @config[:port],
+      ).to_s
+    end
+
+    # wtf..
+    def get *args
+      op(:get, *args)
+    end
+
+    def post *args
+      op(:post, *args)
+    end
+
+    def put *args
+      op(:put, *args)
+    end
+
+    def delete *args
+      op(:delete, *args)
+    end
+
+    private
+
+    def op (method, *args)
+      unless @api_key.nil?
+        @conn.basic_auth(@api_key, '')
+      end
+      @conn.send(method, *args)
+    end
+
+  end
+
+end

data/lib/balanced/resources.rb

@@ -0,0 +1,160 @@
+module Balanced
+
+  class ApiKey < Resource
+  end
+
+  class Account < Resource
+
+    def debit (amount=nil,
+        appears_on_statement_as=nil,
+        hold_uri=nil,
+        meta=nil,
+        description=nil,
+        source_uri=nil)
+      debit = Debit.new(
+          :uri => self.debits_uri,
+          :amount => amount,
+          :appears_on_statement_as => appears_on_statement_as,
+          :hold_uri => hold_uri,
+          :meta => meta,
+          :description => description,
+          :source_uri => source_uri,
+      )
+      debit.save
+    end
+
+    def hold amount, meta={}, source_uri=nil
+      hold = Hold.new(
+          :uri => self.holds_uri,
+          :amount => amount,
+          :meta => meta,
+          :source_uri => source_uri,
+      )
+      hold.save
+    end
+
+    def credit amount, description=nil, meta={}, destination_uri=nil
+      credit = Credit.new(
+          :uri => self.debits_uri,
+          :amount => amount,
+          :meta => meta,
+          :description => description,
+          :destination_uri => destination_uri,
+      )
+      credit.save
+    end
+
+    def add_card card_uri
+      self.card_uri = card_uri
+      save
+    end
+
+    def add_bank_account bank_account_uri
+      self.bank_account_uri = bank_account_uri
+      save
+    end
+
+    def promote_to_merchant merchant_data
+      self.merchant = merchant
+      save
+    end
+
+  end
+
+  class Merchant < Resource
+
+    def self.me
+
+    end
+
+  end
+
+  class Marketplace < Resource
+
+    def self.my_marketplace
+    end
+
+    def create_buyer email_address, card_uri, name=nil, meta={}
+      account = Account.new(
+        :uri => self.accounts_uri,
+        :email_address => email_address,
+        :card_uri => card_uri,
+        :name => name,
+        :meta => meta,
+      )
+      account.save
+    end
+
+    def create_merchant email_address, merchant, bank_account_uri=nil, name=nil, meta={}
+      account = Account.new(
+        :uri => self.accounts_uri,
+        :email_address => email_address,
+        :merchant => merchant,
+        :bank_account_uri => bank_account_uri,
+        :name => name,
+        :meta => meta,
+      )
+      account.save
+    end
+
+  end
+
+  class Hold < Resource
+
+    def void
+      @is_void = true
+      save
+    end
+
+    def capture amount, appears_on_statement_as, meta, description
+      self.account.debit(amount, appears_on_statement_as, self.uri, meta, description)
+    end
+
+  end
+
+  class Debit < Resource
+
+    def refund amount=nil, description=nil
+      refund = Refund.new(
+          :uri => self.refunds_uri,
+          :debit_uri => self.uri,
+          :amount => amount,
+          :description => description,
+      )
+      refund.save
+    end
+
+  end
+
+  class Credit < Resource
+  end
+
+  class Refund < Resource
+  end
+
+  class Transaction < Resource
+  end
+
+  class Card < Resource
+
+    def debit amount=nil, appears_on_statement_as=nil, holds_uri=nil, meta=nil, description=nil
+      self.account.debit(amount, appears_on_statement_as, holds_uri, meta, description, self.uri)
+    end
+
+    def hold amount=nil, meta=nil
+      self.account.hold(amount, meta, self.uri)
+    end
+  end
+
+  class BankAccount < Resource
+
+    def debit amount, appears_on_statement_as=nil, meta=mil, description=nil
+      self.account.debit(amount, appears_on_statement_as, meta, description, self.uri)
+    end
+
+    def credit amount, description=nil, meta=nil
+      self.account.credit(amount, description, meta, self.uri)
+    end
+  end
+
+end

data/lib/balanced/utils.rb

@@ -0,0 +1,48 @@
+module Balanced
+  module Utils
+    def camelize underscored_word
+      underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+
+    def classify table_name
+      camelize singularize(table_name.to_s.sub(/.*\./, ''))
+    end
+
+    def demodulize class_name_in_module
+      class_name_in_module.to_s.sub(/^.*::/, '')
+    end
+
+    def pluralize word
+      word.to_s.sub(/([^s])$/, '\1s')
+    end
+
+    def singularize word
+      word.to_s.sub(/s$/, '').sub(/ie$/, 'y')
+    end
+
+    def underscore camel_cased_word
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr! "-", "_"
+      word.downcase!
+      word
+    end
+
+    def hash_with_indifferent_read_access base = {}
+      indifferent = Hash.new { |hash, key| hash[key.to_s] if key.is_a? Symbol }
+      base.each_pair { |key, value| indifferent[key.to_s] = value }
+      indifferent
+    end
+
+    def stringify_keys! hash
+      hash.keys.each do |key|
+        stringify_keys! hash[key] if hash[key].is_a? Hash
+        hash[key.to_s] = hash.delete key if key.is_a? Symbol
+      end
+    end
+
+    extend self
+  end
+end

data/lib/balanced/version.rb

@@ -1,3 +1,3 @@
 module Balanced
-  VERSION = '0.1.0'
-end
+  VERSION = '0.2.0'
+end

data/spec/api_key_spec.rb

@@ -0,0 +1,20 @@
+require "balanced"
+
+describe "ApiKey Resource" do
+  before(:each) do
+  end
+
+  it "should create my api key and let me access the secret" do
+    key = Balanced::ApiKey.new.save
+    key.should_not eq(nil)
+    # make sure my secret is there.
+    key.secret.should_not eq(nil)
+  end
+
+  it "should construct the merchant sub resource as an instance of Balanced::Merchant" do
+    key = Balanced::ApiKey.new.save
+    (key.merchant.instance_of? Balanced::Merchant).should == true
+  end
+
+
+end

data/spec/balanced_spec.rb

@@ -0,0 +1,16 @@
+require "balanced"
+
+describe "Balanced module" do
+  before(:each) do
+    Balanced.configure "some-secret"
+  end
+
+  it "should have a non-nil client" do
+    Balanced.client.should_not eq(nil)
+  end
+
+  its "client should not have a nil conn" do
+    Balanced.client.conn.should_not eq(nil)
+  end
+
+end

data/spec/client_spec.rb

@@ -0,0 +1,12 @@
+require "balanced"
+
+describe "balanced client" do
+
+  it "should allow setting and reading of the api_key" do
+    client = Balanced::Client.new "miscreant"
+    client.api_key.should eq("miscreant")
+    client.api_key = "foo"
+    client.api_key.should eq("foo")
+  end
+
+end

data/spec/utils_spec.rb

@@ -0,0 +1,8 @@
+require "balanced"
+
+describe "the utils module" do
+  it "should correctly translate underscored names" do
+    result = Balanced::Utils.camelize "api_key"
+    result.should eq("ApiKey")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: balanced
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-05-19 00:00:00.000000000 Z
 dependencies: []
 description: ! "Balanced is the payments platform for marketplaces.\n    Integrate
   a payments experience just like Amazon for your marketplace.\n    Forget about dealing
@@ -29,8 +29,15 @@ files:
 - balanced.gemspec
 - examples/examples.rb
 - lib/balanced.rb
+- lib/balanced/base.rb
+- lib/balanced/client.rb
+- lib/balanced/resources.rb
+- lib/balanced/utils.rb
 - lib/balanced/version.rb
-- tests/balanced-specs.rb
+- spec/api_key_spec.rb
+- spec/balanced_spec.rb
+- spec/client_spec.rb
+- spec/utils_spec.rb
 homepage: https://balancedpayments.com
 licenses: []
 post_install_message: 
@@ -55,4 +62,8 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Sign up on https://balancedpayments.com/
-test_files: []
+test_files:
+- spec/api_key_spec.rb
+- spec/balanced_spec.rb
+- spec/client_spec.rb
+- spec/utils_spec.rb