fortenet 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e67a8b5988114736828681492465ac7762c2030
-  data.tar.gz: c67486ddabb475c3a6306155b50a6aaa7f7a119e
+  metadata.gz: 4ef7780ec10bbeaeb46a6972034216bf7f891462
+  data.tar.gz: e5a55d9e20235b79aedc8635732a01511b15441f
 SHA512:
-  metadata.gz: 8440db39840e0bf2968d7dad4133be984850287670550e168c8243387758f8f53bb80bc34295ed6a8a0c069f485378e6f6b5fda7d58ee03860031306ba53287b
-  data.tar.gz: c8f951a2f8d2affe0565837083834a0fa36c2501152eafa6103b0e6562ce2b56eaae5c6e1cc4ecb01e9183b322dddb86e77e764f894ab2d4e9db8c9304bba7a0
+  metadata.gz: 023e76cb886af4dbd45432d8fadea074314acb3cf337ed1d38921ceda17788f172e69c1bb3ea35b742af5551ea2968fc49eb9395af47b8678613cdf4cfe0bc65
+  data.tar.gz: fdf169c1efbab195c7a79236f0061428cfaf213fd290be10cf518e21f6e3bf193d04f6e142448cd13415e42a448dfe885bf4ed9873bcc4492a7d090617d14935

data/README.md

@@ -2,19 +2,18 @@
 
 Simple Ruby wrapper for Forte Payments REST API
 
-Learn about the Forte Payments REST API at https://www.forte.net/devdocs/api_resources/forte_api_v3.htm
+Learn about the [Forte Payments REST API](https://www.forte.net/devdocs/api_resources/forte_api_v3.htm)
 
 ### Installation
-Add this line to your application's Gemfile:
 ```ruby
   # in your Gemfile
-  gem 'fortenet', '3.0.1', git: 'https://github.com/iiwo/fortenet'
+  gem 'fortenet'
 
   # then...
   bundle install
 ```
 
-### Usage
+### Setup
 Create an initializer
 ```ruby
   # config/initializers/fortenet.rb
@@ -23,6 +22,7 @@ Create an initializer
     config.endpoint = ENV['FORTE_ENDPOINT']
     config.api_login_id = ENV['FORTE_API_LOGIN_ID']
     config.secure_transaction_key = ENV['FORTE_SECURE_TRANSACTION_KEY']
+
     # use the ID values without the prefixes ie. 123456 and not org_123456
     config.account_id = ENV['FORTE_ACCOUNT_ID'] # this is also called organization ID
     config.location_id = ENV['FORTE_LOCATION_ID']
@@ -34,12 +34,23 @@ Create an initializer
     # optionally configure proxy
     config.proxy_host = ENV['FORTE_PROXY_HOST']
     config.proxy_port = ENV['FORTE_PROXY_PORT']
-    config.proxy_user =ENV['FORTE_PROXY_USER']
+    config.proxy_user = ENV['FORTE_PROXY_USER']
     config.proxy_password = ENV['FORTE_PROXY_PASSWORD']
   end
 ```
 
-Perform a request
+### Usage
+
+`Fortenet::Client` implements `find`, `create`, `update`, and `destroy` for interacting with Forte.
+
+The first arg for all commands is the relative path without any leading backslashes. The second arg for find/create/update is the request data and may either be a hash or a json string.
+
+For example `Fortenet::Client.new.create('transactions, data)` will ensure data is a json string and post to forteat "/organizations/org_#{account_id}/locations/loc_#{location_id}/transactions" with headers setup using initializer config settings for authentication.
+
+Forte client calls will return an [`HTTParty::Response`](http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/Response) which you can interact with. You can also call `parsed_response` on the actual `Fortenet::Client` instance to get back json parsed hash with symbolized keys.
+
+#### Examples
+
 ```ruby
 client = Fortenet::Client.new
 
@@ -67,11 +78,3 @@ client.create('transactions', request)
 # sample PUT request
 client.update('transactions', request)
 ```
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/fortenet/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/lib/fortenet.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'json'
 require 'fortenet/version'
 
 module Fortenet
@@ -29,9 +30,9 @@ module Fortenet
 
 end
 
+require 'fortenet/options'
 require 'fortenet/request'
 require 'fortenet/client'
 
-
 # default starting point
 Fortenet.debug_output = $stdout

data/lib/fortenet/client.rb

@@ -1,36 +1,32 @@
 module Fortenet
   class Client < Fortenet::Request
-
-    def initialize(account_id = Fortenet.account_id, location_id = Fortenet.location_id, attrs = {})
-      @location_id = location_id
-      @account_id = account_id
-    end
-
-    def base_path
-      "/organizations/org_#{@account_id}/locations/loc_#{@location_id}/"
+    def initialize(account_id = Fortenet.account_id, location_id = Fortenet.location_id)
+      self.base_path = "/organizations/org_#{account_id}/locations/loc_#{location_id}/"
     end
 
     def find(relative_path, data = nil)
-      self.get(base_path+relative_path, query: data)
+      get(base_path + relative_path, query: data)
     end
 
     def create(relative_path, data = nil)
-      self.post(base_path+relative_path, body: data_to_json(data))
+      post(base_path + relative_path, body: data_to_json(data))
     end
 
     def update(relative_path, data = nil)
-      self.put(base_path+relative_path, body: data_to_json(data))
+      put(base_path + relative_path, body: data_to_json(data))
     end
 
     def destroy(relative_path)
-      self.delete(base_path+relative_path)
+      delete(base_path + relative_path)
     end
 
     private
 
-    def data_to_json(data)
-      data.is_a?(Hash) ? data.to_json : data
-    end
+      attr_accessor :base_path
+
+      def data_to_json(data)
+        data.is_a?(Hash) ? data.to_json : data
+      end
 
   end
-end
+end

data/lib/fortenet/options.rb

@@ -0,0 +1,35 @@
+module Fortenet
+  class Options
+    def initialize(options)
+      self.options = options
+    end
+
+    def call
+      {
+        format: :plan,
+        headers: header_settings
+      }.merge(proxy_settings).merge(options)
+    end
+
+    private
+
+      attr_accessor :options
+
+      def proxy_settings
+        {}.tap do |options|
+          options[:http_proxyaddr] = Fortenet.proxy_host if Fortenet.proxy_host.present?
+          options[:http_proxyport] = Fortenet.proxy_port if Fortenet.proxy_port.present?
+          options[:http_proxyuser] = Fortenet.proxy_user if Fortenet.proxy_user.present?
+          options[:http_proxypass] = Fortenet.proxy_password if Fortenet.proxy_user.present?
+        end
+      end
+
+      def header_settings
+        {
+          'X-Forte-Auth-Organization-Id' => "org_#{Fortenet.account_id}",
+          'Content-Type' => 'application/json',
+          'Authorization' => "Basic #{Base64.strict_encode64("#{Fortenet.api_login_id}:#{Fortenet.secure_transaction_key}")}"
+        }
+      end
+  end
+end

data/lib/fortenet/request.rb

@@ -1,56 +1,42 @@
-require 'httparty'
-require 'json'
-
 module Fortenet
   class Request
     include HTTParty
+
     format :json
     headers 'Accept' => 'application/json'
 
-    def get(path, options={})
-      set_auth(options)
-      @response = self.class.get(Fortenet.endpoint + path, options)
-    end
+    attr_reader :response
 
-    def post(path, options={})
-      set_auth(options)
-      @response = self.class.post(Fortenet.endpoint + path, options)
+    def get(path, **options)
+      self.response = self.class.get(Fortenet.endpoint + path, set_auth(options))
     end
 
-    def put(path, options={})
-      set_auth(options)
-      @response = self.class.put(Fortenet.endpoint + path, options)
+    def post(path, **options)
+      self.response = self.class.post(Fortenet.endpoint + path, set_auth(options))
     end
 
-    def delete(path, options={})
-      set_auth(options)
-      @response = self.class.delete(Fortenet.endpoint + path, options)
+    def put(path, **options)
+      self.response = self.class.put(Fortenet.endpoint + path, set_auth(options))
     end
 
-    def response
-      @response
+    def delete(path, **options)
+      self.response = self.class.delete(Fortenet.endpoint + path, set_auth(options))
     end
 
     def parsed_response
-      self.response.parsed_response if self.response.present?
+      return if response.nil?
+
+      JSON.parse response.body, symbolize_names: true
     end
 
     private
 
-    def set_auth(options)
-      client_id_and_secret = Base64.strict_encode64("#{Fortenet.api_login_id}:#{Fortenet.secure_transaction_key}")
-      #options[:ssl_version] = :TLSv1
-      options[:headers] ||= {}
-      options[:headers]['X-Forte-Auth-Organization-Id'] = "org_#{Fortenet.account_id}"
-      options[:headers]["Content-Type"] = "application/json"
-      options[:headers]['Authorization'] = "Basic #{client_id_and_secret}"
-
-      options[:http_proxyaddr] = Fortenet.proxy_host if Fortenet.proxy_host.present?
-      options[:http_proxyport] = Fortenet.proxy_port if Fortenet.proxy_port.present?
-      options[:http_proxyuser] = Fortenet.proxy_user if Fortenet.proxy_user.present?
-      options[:http_proxypass] = Fortenet.proxy_password if Fortenet.proxy_user.present?
-    end
+      attr_writer :response
+
+      def set_auth(options)
+        Fortenet::Options.new(options).call
+      end
 
   end
 
-end
+end

data/lib/fortenet/version.rb

@@ -1,3 +1,3 @@
 module Fortenet
-  VERSION = "3.0.2"
+  VERSION = '3.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fortenet
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Iwo Dziechciarow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,6 +67,7 @@ files:
 - fortenet.gemspec
 - lib/fortenet.rb
 - lib/fortenet/client.rb
+- lib/fortenet/options.rb
 - lib/fortenet/request.rb
 - lib/fortenet/version.rb
 homepage: https://github.com/ArcadiaPower/fortenet