forte_ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 852a87ffd6c62de4916270db40bb58788fbbf071
+  data.tar.gz: 9440db96d8fcdddf7bfee5162cf6239366f00da3
+SHA512:
+  metadata.gz: 81c932956a076d805de8aed7788f07e1a5c1961af6cb45a5d617ff05bf8d3f69d49e149f59ff26570893ca06b573e2a45fa2797b87368dd05ecdd0d1fe1d0170
+  data.tar.gz: 2ccf18cc2ff9d0def6411d2e5e9efb3150e105a20285b6a65a30c600c624a05012fdb971147ce95e86881df5c4d01949daaa291dab5489ae7166058421c6972e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ruslan Milevskiy
+
+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/README.md

@@ -0,0 +1,92 @@
+# ForteRuby
+
+The ForteRuby provides Ruby APIs for customers, addresses, settlements and transactions resourses using the Forte API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forte_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install forte_ruby
+
+## Usage
+
+Create a configuration file(`config/forte_ruby.yml`):
+
+```yaml
+development: &default 
+  api_login_id: your_login_id
+  secure_transaction_key: you_key
+  account_id: your_account_id
+  location_id: you_location_id
+  endpoint: https://sandbox.forte.net/api/v1
+
+test: 
+  <<: *default
+
+production:
+  api_login_id: your_login_id
+  secure_transaction_key: you_key
+  account_id: your_account_id
+  location_id: you_location_id
+  endpoint: https://forte.net/api/v1
+```
+
+Get customers list
+
+```ruby
+  ForteRuby.customers.all
+```
+
+Update/delete customer
+
+```ruby
+  customer = ForteRuby.customers.all.first
+  customer.update(first_name: 'Bob')
+  customer.delete
+```
+
+Create new customer
+
+```ruby
+  customer = ForteRuby.customers.build_from(first_name: 'Bob')
+  customer.save
+```
+
+Find customer by id
+
+```ruby
+  ForteRuby.customers.find_by_id('cst_123')
+```
+
+Use filters to get customers
+
+```ruby
+  ForteRuby.customers.filter(first_name: 'Bob')
+```
+
+Get addresses list
+
+```ruby
+  customer = ForteRuby.customers.all.first
+  addresses = customer.addresses.all
+```
+
+You can use the same methods for transactions and settlements. But this gem provide only read operations for them.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/forte_ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/forte_ruby.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forte_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forte_ruby"
+  spec.version       = ForteRuby::VERSION
+  spec.authors       = ["Ruslan Milevskiy"]
+  spec.email         = ["rpmilevskiy@gmail.com"]
+  spec.summary       = %q{Ruby gem for Forte API}
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'resultable'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry'
+end

data/lib/forte_ruby/api/base.rb

@@ -0,0 +1,52 @@
+require "base64"
+require "resultable"
+require "ostruct"
+require "yaml"
+require 'rest-client'
+
+module ForteRuby
+  module API
+    class Base
+      include Resultable
+
+      attr_accessor :request_data
+
+      def initialize(params = {})
+        set_attributes(params)
+        self.request_data ||= RequestData.new
+      end
+      
+      private
+
+      def send_request(url, method, params = nil)
+        self.result = Result.new
+
+        unless request_data.config
+          result.error = 'Provide configs in forte_ruby.yml file'
+          return result
+        end
+
+        params = params ? JSON.generate(params) : nil
+        begin
+          response = RestClient.send(method, url, *[params, request_data.headers].compact)
+          result.successful!
+          if block_given? 
+            yield(response)
+          else
+            result.response = JSON.parse(response)
+          end
+        rescue RestClient::Exception => e
+          result.response = JSON.parse(e.response)['response']['response_desc']
+        end
+
+        result
+      end
+
+      def set_attributes(attributes)
+        attributes.each do |key, value|
+          self.send("#{key}=", value) if self.respond_to?(key)
+        end
+      end
+    end
+  end
+end

data/lib/forte_ruby/api/object.rb

@@ -0,0 +1,52 @@
+module ForteRuby
+  module API
+    class Object < Base
+
+      attr_accessor :new
+
+      def delete
+        send_request(url, :delete)
+      end
+
+      def update(params)
+        set_attributes(params)
+        save
+      end
+
+      def save
+        method_name = new? ? :post : :put
+
+        result = send_request(url, method_name, api_attributes_hash)
+
+        if result.successful? && new?
+          set_attributes(result.response.merge(new: false))
+        end
+
+        result
+      end
+
+      protected
+
+      def url
+        raise 'Impelement it'
+      end
+      
+      def api_attributes
+        raise 'Impelement it'
+      end
+
+      private
+
+      def api_attributes_hash
+        api_attributes.inject({}) do |hash, element|
+          hash[element] = self.send(element)
+          hash
+        end
+      end
+
+      def new?
+        new
+      end
+    end
+  end
+end

data/lib/forte_ruby/api/objects.rb

@@ -0,0 +1,51 @@
+module ForteRuby
+  module API
+    class Objects < Base
+      def all
+        send_request(url, :get) do |response|
+          parse_response(response)
+        end
+      end
+
+      def build_from(params)
+        single_class.new(params.merge(request_data: request_data, new: true))
+      end
+
+      def find_by_id(id)
+        send_request(url + "/#{id}", :get) do |response|
+          parse_response(response)
+        end
+      end
+
+      def filter(params)
+        filter_value = params.map{ |key, value| "#{key}+eq+#{value}"}.join("+and+")
+        send_request(url + "?filter=#{filter_value}", :get) do |response|
+          parse_response(response)
+        end
+      end
+
+      protected
+
+      def single_class
+        raise 'Impelement it'
+      end
+
+      def url
+        raise 'Impelement it'
+      end
+
+      private
+
+      def parse_response(response)
+        parsed_response = JSON.parse(response)
+        if parsed_response['results']
+          self.result = parsed_response['results'].map do |object_params| 
+            single_class.new(object_params.merge(request_data: request_data))
+          end
+        else
+          self.result = single_class.new(parsed_response)
+        end
+      end
+    end
+  end
+end

data/lib/forte_ruby/api/request_data.rb

@@ -0,0 +1,45 @@
+module ForteRuby
+  module API
+    class RequestData
+      attr_accessor :config
+
+      def initialize
+        self.config = parse_config_file
+      end
+
+      def base_url
+        "#{config.endpoint}/accounts/#{account_id}/locations/#{location_id}"
+      end
+
+      def headers
+        {
+          'X-Forte-Auth-Account-Id' => account_id,
+          'Authorization' => "Basic #{signature}",
+          'Accept' => 'application/json',
+          'Content-Type' => 'json'
+        }
+      end
+
+      private
+
+      def account_id
+        "act_#{config.account_id}"
+      end
+
+      def location_id
+        "loc_#{config.location_id}"
+      end
+
+      def parse_config_file
+        file = Rails.root.join("config").join("forte_ruby.yml")
+        data = YAML.load(ERB.new(IO.read(file)).result)[Rails.env] rescue nil
+        data ? OpenStruct.new(data) : data
+      end
+
+      def signature
+        credentials = "#{config.api_login_id}:#{config.secure_transaction_key}"
+        Base64.encode64(credentials).gsub("\n", "")
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/address.rb

@@ -0,0 +1,27 @@
+module ForteRuby
+  module Resourses
+    class Address < API::Object
+      
+      API_ATTRIBUTES = [
+        :first_name, :last_name, :company_name, :phone, :fax, :email,
+        :label, :address_type, :shipping_address_type, :physical_address
+      ]
+
+      API_ATTRIBUTES.each do |attribute|
+        attr_accessor attribute
+      end
+
+      attr_accessor :customer_token, :address_token
+
+      protected
+
+      def url
+        "#{request_data.base_url}/customers/#{customer_token}/addresses/#{address_token}"
+      end
+      
+      def api_attributes
+        API_ATTRIBUTES
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/addresses.rb

@@ -0,0 +1,22 @@
+module ForteRuby
+  module Resourses
+    class Addresses < API::Objects
+
+      attr_accessor :customer_token
+
+      def build_from(params)
+        single_class.new(params.merge(request_data: request_data, new: true, customer_token: customer_token))
+      end
+
+      protected
+
+      def single_class
+        Address
+      end
+
+      def url
+        "#{request_data.base_url}/customers/#{customer_token}/addresses"
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/customer.rb

@@ -0,0 +1,29 @@
+module ForteRuby
+  module Resourses
+    class Customer < API::Object
+      
+      API_ATTRIBUTES = [
+        :customer_token, :customer_id, :default_paymethod_token, :default_billing_address_token, :default_shipping_address_token,
+        :status, :last_name, :first_name, :company_name, :paymethod
+      ]
+
+      API_ATTRIBUTES.each do |attribute|
+        attr_accessor attribute
+      end
+
+      def addresses
+        Addresses.new(request_data: request_data, customer_token: customer_token)
+      end
+
+      protected
+
+      def url
+        "#{request_data.base_url}/customers/#{customer_token}"
+      end
+      
+      def api_attributes
+        API_ATTRIBUTES
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/customers.rb

@@ -0,0 +1,16 @@
+module ForteRuby
+  module Resourses
+    class Customers < API::Objects
+
+      protected
+
+      def single_class
+        Customer
+      end
+
+      def url
+        "#{request_data.base_url}/customers"
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/settlement.rb

@@ -0,0 +1,43 @@
+module ForteRuby
+  module Resourses
+    class Settlement < API::Object
+      
+      API_ATTRIBUTES = [
+        :customer_token, :customer_id, :order_number, :reference_id, :settle_id, :transaction_id, :settle_date, :settle_type,
+        :settle_response_code, :settle_amount, :method
+      ]
+
+      API_ATTRIBUTES.each do |attribute|
+        attr_accessor attribute
+      end
+
+      COMPLETED_RESPONSE_CODE = 'A01'
+
+      def delete
+        raise 'It is not implemented'
+      end
+
+      def update
+        raise 'It is not implemented'
+      end
+
+      def save
+        raise 'It is not implemented'
+      end
+
+      def status
+        if response_code == COMPLETED_RESPONSE_CODE
+          'completed'
+        else
+          'declined'
+        end
+      end
+
+      protected
+      
+      def api_attributes
+        API_ATTRIBUTES
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/settlements.rb

@@ -0,0 +1,16 @@
+module ForteRuby
+  module Resourses
+    class Settlements < API::Objects
+
+      protected
+
+      def single_class
+        Settlement
+      end
+
+      def url
+        "#{request_data.base_url}/settlements"
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/transaction.rb

@@ -0,0 +1,34 @@
+module ForteRuby
+  module Resourses
+    class Transaction < API::Object
+      
+      API_ATTRIBUTES = [
+        :action, :one_time_token, :customer_token, :customer_id, :paymethod_token, :reference_id, :authorization_amount, :order_number,
+        :original_transaction_id, :transaction_id, :authorization_code, :software_name, :entered_by, :received_date, :origination_date,
+        :customer_accounting_code, :sales_tax_amount, :service_fee_amount, :sec_code, :billing_address, :shipping_address, :paymethod
+      ]
+
+      API_ATTRIBUTES.each do |attribute|
+        attr_accessor attribute
+      end
+
+      def delete
+        raise 'It is not implemented'
+      end
+
+      def update
+        raise 'It is not implemented'
+      end
+
+      def save
+        raise 'It is not implemented'
+      end
+
+      protected
+      
+      def api_attributes
+        API_ATTRIBUTES
+      end
+    end
+  end
+end

data/lib/forte_ruby/resourses/transactions.rb

@@ -0,0 +1,16 @@
+module ForteRuby
+  module Resourses
+    class Transactions < API::Objects
+
+      protected
+
+      def single_class
+        Transaction
+      end
+
+      def url
+        "#{request_data.base_url}/transactions"
+      end
+    end
+  end
+end

data/lib/forte_ruby/version.rb

@@ -0,0 +1,3 @@
+module ForteRuby
+  VERSION = "0.1.1"
+end

data/lib/forte_ruby.rb

@@ -0,0 +1,27 @@
+require "forte_ruby/version"
+require "forte_ruby/api/base"
+require "forte_ruby/api/objects"
+require "forte_ruby/api/object"
+require "forte_ruby/api/request_data"
+require "forte_ruby/resourses/customers"
+require "forte_ruby/resourses/customer"
+require "forte_ruby/resourses/addresses"
+require "forte_ruby/resourses/address"
+require "forte_ruby/resourses/transactions"
+require "forte_ruby/resourses/transaction"
+require "forte_ruby/resourses/settlements"
+require "forte_ruby/resourses/settlement"
+
+module ForteRuby
+  def self.customers
+    ForteRuby::Resourses::Customers.new
+  end
+
+  def self.transactions
+    ForteRuby::Resourses::Transactions.new
+  end
+
+  def self.settlements
+    ForteRuby::Resourses::Settlements.new
+  end
+end

data/spec/cassettes/address/create/error.yml

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://c2wL3J074JUdaU5k07HQ6m4BcPpeAY1m:c3wojAimKJ8MVEPYjCVl2qvzjczxXDbe@sandbox.forte.net/api/v1/accounts/act_300044/locations/loc_169531/customers/cst_5I5j8RuSCU6kmt3_miCtZQ/addresses/
+    body:
+      encoding: UTF-8
+      string: '{"first_name":null,"last_name":null,"company_name":null,"phone":null,"fax":null,"email":null,"label":null,"address_type":"unexisted","shipping_address_type":null,"physical_address":null}'
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      X-Forte-Auth-Account-Id:
+      - act_300044
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '186'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - Microsoft-IIS/7.5
+      Www-Authenticate:
+      - Basic realm="sandbox.forte.net"
+      X-Aspnet-Version:
+      - 4.0.30319
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 17 Mar 2015 15:37:19 GMT
+      Expires:
+      - "-1"
+      Pragma:
+      - no-cache
+      Connection:
+      - close
+      Set-Cookie:
+      - X-Mapping-gbooldlg=0DBF2E22300A61A18D35B33164C4A32E;path=/
+      X-Powered-By:
+      - ASP.NET
+      Content-Length:
+      - '325'
+    body:
+      encoding: UTF-8
+      string: '{"response":{"response_desc":"Error[1]: The content in the request
+        produced errors while parsing. Check that the content is correctly formatted
+        for the Content-Type provided. Error[2]: Unexpected value for AddressType
+        Error[3]: Error location: ,\"shipping_address_type\":null,\"physical_address\":n","environment":"sandbox"}}'
+    http_version: 
+  recorded_at: Tue, 17 Mar 2015 15:37:19 GMT
+recorded_with: VCR 2.9.3