espago 0.0.9 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f06d19baed38844060f767678cc1e08df0b64ba
-  data.tar.gz: 40a3d3d5c42aa5751425aaf3f6ac47428f2b5168
+  metadata.gz: 27e99a50c2ebe74762fb3cfbb1d808dfc465fdb9
+  data.tar.gz: dfeead9293c23e0c4f4d3a7ccc682d21ef327cb1
 SHA512:
-  metadata.gz: 76c47df71036ce428b04abf38ab7dad46122b4d92cc833dfc7280634845dc3ae6e4f3d6b053b95cf4d6f648bd4f6d155ba111a9d3c78688357b15dc5e4370d42
-  data.tar.gz: cb034408241e51d751e5bdeb37fce8015a0fbe5e8825c827d2d1b4a6a4241a8ed965e7f7a068599d91b125a8189689dd507e2df1f9da4408eb006a3c1963788b
+  metadata.gz: 206a547e448d6cf77996f7d288d9ef563042f7521f6c8d6918dba776fbfdb19708a7939fb8ad51087879035bcbd6273e4f50120691c084f1193d9ed24d492592
+  data.tar.gz: ac022203b3f4ede07c8ea8e2e7298e70e843456f7aedd7f5c86957c362de0914d234ca9e5996628eb35bddfb2479dbcc6bc9340ad635fe1990d2552a3df93570

data/.travis.yml

@@ -3,3 +3,9 @@ rvm:
   - "1.9.2"
   - "1.9.3"
   - "2.0.0"
+  - "2.1.5"
+
+addons:
+  code_climate:
+    repo_token:
+      secure: 6c7689ce08533f243c6949aabf49abada63dc24f5e1bf5c4a6dfdb20080b95fa

data/Gemfile.lock

@@ -1,14 +1,19 @@
 PATH
   remote: .
   specs:
-    espago (0.0.9)
+    espago (0.1.2)
       facets
       faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.3.6)
+    codeclimate-test-reporter (0.4.1)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.0.8)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.1.3)
     facets (2.9.3)
     faraday (0.8.7)
@@ -46,17 +51,23 @@ GEM
     rspec-instafail (0.2.4)
     rspec-mocks (2.12.1)
     ruby-progressbar (1.0.2)
+    safe_yaml (1.0.4)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     slop (3.3.3)
     thor (0.16.0)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter
   espago!
   fuubar
   guard-rspec
@@ -65,3 +76,5 @@ DEPENDENCIES
   rb-fsevent (~> 0.9.1)
   rspec
   simplecov
+  vcr
+  webmock

data/Guardfile

@@ -3,6 +3,7 @@
 
 guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/features/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^lib/espago/(.+)\.rb$})     { |m| "spec/espago/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -2,6 +2,9 @@ Espago gem
 ======
 
 [![Build Status](https://travis-ci.org/espago/espago.png?branch=master)](https://travis-ci.org/espago/espago)
+[![Gem Version](https://badge.fury.io/rb/espago.svg)](http://badge.fury.io/rb/espago)
+[![Code Climate](https://codeclimate.com/github/espago/espago/badges/gpa.svg)](https://codeclimate.com/github/espago/espago)
+[![Test Coverage](https://codeclimate.com/github/espago/espago/badges/coverage.svg)](https://codeclimate.com/github/espago/espago)
 
 ### Installing Espago gem
 
@@ -11,9 +14,7 @@ or just add it to your Gemfile if you are running a Rails project
 
 ## Configuration
 
-After registering at <http://espago.com> configure your app with the security credentials.
-
-### Global
+After registering at <http://espago.com> configure your app with the security credentials. More information about configuration of merchant account you can find in our documentation <https://espago.com/doc/en>
 
 The most standard way of configuring Espago is to do it globally on the Espago class.
 
@@ -21,8 +22,119 @@ The most standard way of configuring Espago is to do it globally on the Espago c
     Espago.app_password = 'your-espago-secret'
     Espago.public_key = 'your-espago-key'
     Espago.production = false #sets Espago enviroment to sandbox
+    Espago.api_version = 2
+
+## Sending request
+
+There are two possible ways of sending requests by using Espago gem.
+The first possibility is to call everytime send_request() function with proper path, HTTP method and parameters.
+
+    Espago.send_request path, request_type, [parameters]
+
+Here it is an example of using this way to create new client:
+
+    Espago.send_request :clients, :post, {description: "Jan Kowalski", email: "kowalski@example.com", card: {first_name: "Jan", last_name: "Kowalski", number: "4242424242424242", year: "2019", month: "03"}}
+
+The second possible way to sending requests by Espago gem is to call the proper path on Espago object, using specific HTTP method and setting chosen parameteres.
+
+    Espago.path request_type, [parameters]
+
+Below, it is an example of using this possibility to create new client:
+
+    Espago.clients :post, {description: "Jan Kowalski", email: "kowalski@example.com", card: {first_name: "Jan", last_name: "Kowalski", number: "4242424242424242", year: "2019", month: "03"}}
+
+## Getting response
+
+Every returned object includes informations about header and body of response.
+
+For example for request:
+
+    client = Espago.clients :post, {description: "Jan Kowalski", email: "kowalski@example.com", card: {first_name: "Jan", last_name: "Kowalski", number: "4242424242424242", year: "2019", month: "03"}}
+
+Espago returns an special response object:
+
+    #<Espago::Response:0x000001038dba40
+      @body=
+       {"email"=>"kowalski@example.com",
+        "id"=>"cli_N2NNf85cFB1xWs",
+        "created_at"=>1381834598,
+        "description"=>"Jan Kowalski",
+        "card"=>
+         {"company"=>"VI",
+          "last4"=>"4242",
+          "year"=>2019,
+          "month"=>3,
+          "first_name"=>"Jan",
+          "last_name"=>"Kowalski",
+          "authorized"=>nil,
+          "created_at"=>1381834598},
+        "deleted"=>false},
+      @status=201>
+
+To get response status code you should use "status" method.
+For example
+
+    client.status
+
+returns "201" code.
+
+To get body of response you should use "body" method.
+For example
+
+    client.body
+
+can return hash with client details:
+
+    {
+      "email"=>"kowalski@example.com",
+      "id"=>"cli_N2NNf85cFB1xWs",
+      "created_at"=>1381834598,
+      "description"=>"Jan Kowalski",
+      "card"=>
+       {"company"=>"VI",
+        "last4"=>"4242",
+        "year"=>2019,
+        "month"=>3,
+        "first_name"=>"Jan",
+        "last_name"=>"Kowalski",
+        "authorized"=>nil,
+        "created_at"=>1381834598},
+      "deleted"=>false
+    }
+
+Now if you want get customer's e-mail(or anoher field in 1st level of response) this short code should execute operation:
+
+    client.email
+    => "kowalski@example.com"
+
+    client.card
+    => {"company"=>"VI", "last4"=>"4242", "year"=>2019, "month"=>3, "first_name"=>"Jan", "last_name"=>"Kowalski", "authorized"=>nil, "created_at"=>1381834598}
 
-### Sending request
+## All possible paths (resources)
 
-    response = Espago.send_request(:clients, :get)
-    response = Espago.clients :get
+<table align="center">
+<tr>
+  <th>Parameter</th><th>Description</th><th>Documentation link</th>
+</tr>
+<tr>
+  <th>tokens</th><td>special id for credit card</td><td>https://developers.espago.com/en/v2#44-card-tokens</td>
+</tr>
+<tr>
+  <th>clients</th><td>clients data</td><td>https://developers.espago.com/en/v2#55-customers</td>
+</tr>
+<tr>
+  <th>charges</th><td>credit payments</td><td>https://developers.espago.com/en/v2#9-card-payments</td>
+</tr>
+<tr>
+  <th>plans</th><td>plans for recurring payments</td><td>https://developers.espago.com/en/v2#22-plans</td>
+</tr>
+<tr>
+  <th>subscriptions</th><td>recurring payments for client according to the created plan</td><td>https://developers.espago.com/en/v2#28-subscriptions</td>
+</tr>
+<tr>
+  <th>invoices</th><td>single recurring payment</td><td>https://developers.espago.com/en/v2#34-invoices</td>
+</tr>
+<tr>
+  <th>line_items</th><td>element of every invoice</td><td>https://developers.espago.com/en/v2#41-getting-informations-about-line-items-of-invoice</td>
+</tr>
+</table>

data/espago.gemspec

@@ -6,7 +6,7 @@ require 'espago/version'
 Gem::Specification.new do |gem|
   gem.name          = "espago"
   gem.version       = Espago::VERSION
-  gem.authors       = ["Piotrek", "Szymon Fiedler"]
+  gem.authors       = ["Piotrek", "Szymon Fiedler","Waclaw Luczak"]
   gem.email         = ["developers@espago.com"]
   gem.description   = %q{Espago api wrapper}
   gem.summary       = %q{Espago api wrapper}
@@ -27,4 +27,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "fuubar"
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rb-fsevent', '~> 0.9.1'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'codeclimate-test-reporter'
+
+
 end

data/lib/espago.rb

@@ -1,6 +1,7 @@
 require "espago/version"
 require "espago/client"
 require "espago/router"
+require "espago/back_request"
 require 'forwardable'
 
 module Espago
@@ -8,8 +9,8 @@ module Espago
   class << self
     extend Forwardable
 
-    def_delegators :default_client, :public_key, :app_id, :app_password, :send_request, :production
-    def_delegators :default_client, :public_key= , :app_id= , :app_password=, :production=
+    def_delegators :default_client, :public_key, :app_id, :app_password, :api_version, :send_request, :production
+    def_delegators :default_client, :public_key= , :app_id= , :app_password=, :api_version=, :production=
 
     def method_missing(method, *args, &block)
       if Router.new(method, args[0]).path_exists?
@@ -24,4 +25,4 @@ module Espago
       @default_client ||= Espago::Client.new
     end
   end
-end
+end

data/lib/espago/api_connection.rb

@@ -6,16 +6,28 @@ require "espago/error"
 require "espago/response"
 require "facets/kernel/require_all"
 
-require_all "error/*"
-require_all "api_connection/*"
+require "espago/api_connection/api"
+require "espago/api_connection/api_delete"
+require "espago/api_connection/api_get"
+require "espago/api_connection/api_post"
+require "espago/api_connection/api_put"
+
+begin
+  require_all "error/*"
+  require_all "api_connection/*"
+rescue LoadError #if "require_all" method isn't from kernel gem
+  require_rel "error/*"
+  require_rel "api_connection/*"
+end
 
 module Espago
   class ApiConnection
     extend Forwardable
     def_delegator :@connection, :basic_auth, :authenticate
 
-    def initialize(enviroment)
+    def initialize(enviroment,headers)
       @connection = Faraday.new(enviroment)
+      @connection.headers = headers
       @router = Router
     end
 
@@ -37,7 +49,7 @@ module Espago
       when 401
         raise authentication_error(response)
       else
-        raise api_error(response.status, response.body)
+        raise api_error(response)
       end
     end
 
@@ -53,8 +65,5 @@ module Espago
       ApiError.new(response)
     end
 
-    def parse(body)
-      JSON.parse body
-    end
   end
 end

data/lib/espago/api_connection/{post_clients.rb → api.rb}

@@ -1,13 +1,9 @@
 module Espago
   class ApiConnection
-    class PostClients
+    class Api
       def initialize(connection)
         @connection = connection
       end
-
-      def request(params = {})
-        @connection.post 'clients', params
-      end
     end
   end
 end

data/lib/espago/api_connection/api_delete.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ApiDelete < Api
+      def request(path, param_id=nil)
+        @connection.delete "#{path}/#{param_id}"
+      end
+    end
+  end
+end

data/lib/espago/api_connection/api_get.rb

@@ -0,0 +1,13 @@
+module Espago
+  class ApiConnection
+    class ApiGet < Api
+      def request(path, params = {}, param_id=nil)
+        if param_id
+          @connection.get "#{path}/#{param_id}"
+        else
+          @connection.get "#{path}", params
+        end
+      end
+    end
+  end
+end

data/lib/espago/api_connection/api_post.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ApiPost < Api
+      def request(path, params = {})
+        @connection.post path, params
+      end
+    end
+  end
+end

data/lib/espago/api_connection/api_put.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ApiPut < Api
+      def request(path, params={})
+        @connection.put path, params
+      end
+    end
+  end
+end

data/lib/espago/api_connection/charges_complete_post.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ChargesCompletePost < ApiPost
+      def request(params = {})
+        super("charges/#{params[:charge_id]}/complete")
+      end
+    end
+  end
+end

data/lib/espago/api_connection/charges_delete.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ChargesDelete < ApiDelete
+      def request(params = {})
+        super("charges",params[:charge_id])
+      end
+    end
+  end
+end

data/lib/espago/api_connection/charges_get.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ChargesGet < ApiGet
+      def request(params = {})
+        super('charges',params,params[:charge_id])
+      end
+    end
+  end
+end

data/lib/espago/api_connection/charges_post.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ChargesPost < ApiPost
+      def request(params = {})
+        super("charges", params)
+      end
+    end
+  end
+end

data/lib/espago/api_connection/{post_charges_refund.rb → charges_refund_post.rb}

@@ -1,10 +1,6 @@
 module Espago
   class ApiConnection
-    class PostChargesRefund
-      def initialize(connection)
-        @connection = connection
-      end
-
+    class ChargesRefundPost < Api
       def request(params = {})
         @connection.post "charges/#{params[:charge_id]}/refund", params
       end

data/lib/espago/api_connection/clients_authorize_post.rb

@@ -0,0 +1,9 @@
+module Espago
+  class ApiConnection
+    class ClientsAuthorizePost < ApiPost
+      def request(params = {})
+        super("clients/#{params[:client_id]}/authorize")
+      end
+    end
+  end
+end