rents 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e06c58eb1321502e8141b471a5aba0b782406cb4
-  data.tar.gz: 338f971e9e496295b298b6178d801b37139c7d08
+  metadata.gz: f0fc5c6931a5592f03ae84ebffe92209de8ac213
+  data.tar.gz: 0c00189dfb43eaa7af06a0e7c77d6d840fd470ab
 SHA512:
-  metadata.gz: 73c6a89696092ab521a65ffd26b054120748df24b49dd59d769a4b76146547ac58f7011eb7da059b7540194d47e87b7ff2a2610f6d724036416d26cc32413798
-  data.tar.gz: 510f56ab6d54b8a9292743759ca2e6c4398da68866ffb0ca9dfea7c057e80e5457884c6f0ac60368fbec348ab40f1abefaa3d1a430d59ea25cc6e9dd204bae60
+  metadata.gz: dd42c1000b76dca1cea172603c83e3a4a1c3032e8e847368a4f97f272309e7a666cc99f77bca3d81dc34cdee18b7d7dc2ddd97ff100ef40ab8f09f3b28e896e9
+  data.tar.gz: b6e7b104b9420228868fd1d231aec649dba7d44258899415e632b6958d4e2e8c85262be595716e7d2ee66b0dc753eef7349529a484d0a5bbb8c85918ca4a5c80

data/.gitignore

@@ -8,6 +8,7 @@ InstalledFiles
 _yardoc
 .idea/
 .idea/*
+lib/rents/config/proxy.yml
 coverage
 coverage/
 coverage/*

data/Contributing.md

@@ -0,0 +1,203 @@
+# API Routes
+![API Routes](https://raw.githubusercontent.com/PageRentS/rents-sdk-ruby/master/modeling/API%20Routes.png)
+
+# Simple workflow overview
+
+1. Every class which consumes API must have the `Connection` class as parent
+2. `Connection` implement the HTTP RestClient methods
+3. Every message between the Developer app & the RentS framework must be a HashMap/Dictionary
+4. The object attrs are dynamic, based on the Hash received as constructor param
+5. Instantiation example
+  ```ruby
+    @transaction = Rents::Transaction.new({
+      card:{
+        brand: 'visa',
+        cvv: '123',
+        expiration_month: '05',
+        expiration_year: '2018',
+        number: '4012001037141112',
+        holder: Faker::Name.name,
+      },
+      recurrence_period_id: Rents.enum[:recurrence_periods][:daily],
+      amount: amount
+    })
+    
+    # Charge
+    @resp = @transaction.charge_store 
+    
+    # same as
+    @transaction.charge_store 
+    @transaction.resp
+  ```
+6. The `charge_store` implementation:
+  ```ruby
+    def charge_store full_resp=false
+        # method which setup this attrs to HTTP param, like sold_items array to GET params
+        custom_http_params
+  
+        # dynamic path (the conection just read it path to send the HTTP request, so it is a config before perform)
+        self.path = 'transactions/store'
+  
+        # full_resp = need the full HTTP Response (with code, headers...) 
+        # if not full_resp return just Hash/Dictionary resp
+        full_resp ? self.resp = self.post_request : self.resp = self.post_json_request
+  
+        # return it received resp
+        self.resp
+      end
+  ```
+7. It `Connection.new.post_request` implementation:
+
+  ```ruby
+    def post_request
+      # URL configured on the Connection child class method & the params received from the constructor
+      RestClient.post self.url_requested, self.request_params
+    end
+  ```
+8. It `Connection.new.post_json` implementation
+  ```ruby
+    resp = RestClient.post(self.url_requested, self.request_params)
+    to_hash_with_symbols(resp)
+    
+    # Used on all the _json requests
+    def to_hash_with_symbols json
+      JSON.parse(json).it_keys_to_sym
+    end
+  ```
+
+
+# What the user (developer) see
+
+1. A file which the developer config his environment:
+
+  ```ruby
+    # The RentS give to you 2 diferent apps, the production & the ratification (homolog) app
+    if developement_env || test_env
+      # Example using direct declaration (bad way, but must be possible)
+      Rents.app_id = 'YOUR_APP_ID'
+      Rents.secret_key = 'YOUR_APP_SECRET_KEY'
+      
+      # TODO: Uncomment test_env if you want to test using RentS default_global app
+      # Rents.test_env = true
+      
+      # TODO: Uncomment debugger if you have an RentS instance on your machine
+      # Rents.debug = true
+    else
+      # Production app
+      # Example using the secret config file
+      # REMEMBER to tell the client to not versioned those config files, like the SECRETs on the RAILS
+      # Extensions config files: 
+      #   (Ruby => .YML, PHP => .INI, JavaScript => JSON, ObjectiveC => .PLIST, C# => .DLL, Java => .XML)
+      Rents.app_id = Rails.application.secrets.rents['app_id']
+      Rents.secret_key = Rails.application.secrets.rents['app_id']
+  ```
+  
+2. The Secret YML example
+
+  ```yml
+    production:
+      rents:
+        app_id: # TODO copy it from your PRODUCTION APP RentS page
+        app_secret_key: # TODO copy it from your PRODUCTION APP RentS page
+  ```
+  
+3. ENUMs You can add ENUMs file or just get it from the API, but to improve the performance, create those files:
+  * Those [__files__](https://github.com/PageRentS/rents-sdk-ruby/tree/master/lib/rents/config/enums) are not visible to the Developer, but he can check if & easy access through a `Rents.enums`
+  * __`brands.yml`__
+    ```yml
+      brands:
+      # SampleObj
+      - id:       0
+        name:     Nil
+        username: nil
+
+      # VISA
+      - id:       1
+        name:     VISA
+        username: visa
+    ```
+  * __`currencies.yml`__
+    ```yml
+      currencies:
+      - id:         0
+        name:       Nil
+        acronym:    nil$
+        iso_code:   NIL
+        iso_number: 000
+      
+        # Real
+      - id:         1
+        name:       Real
+        acronym:    R$
+        iso_code:   BRL
+        iso_number: 986
+    ```
+  * __`proxy.yml`__
+  
+    ```yml
+      login:    c1280361
+      password: 12345678
+      host:     proxy.oranization.com
+      port:     80      
+    ```
+
+# How this work in the core
+1. The Rents is a Module/Namespace which have static methods (config), like: 
+  * `bolean test_env`
+  * `bolean debug`
+  * `enum` (return a HashMap based on the config files: .ini, .yml, .xml, .plist...)
+  * `load_config_file` (return it file to the enum method: `load_yml`, `load_xml`, `load_ini`....)
+  * `proxy` (setup the proxy to the requests, useful for intranets & server apps in shared servers)
+
+2. `Connection.rb`, parent class for all API consumer classes, RestClient (GET, POST, PUT, DELETE)
+  * It must have both methods: `http_method_json` & `http_method`, `setup_default_app`
+  * `setup_default_app`: setup a `Rents.app_id` & `Rents.secret_key` & `this.recurrent_rid`
+  * `setup_default_app` also setup the auth: `this.auth = {app_id:Rents.app_id, secret_key:Rents.secret_key}`
+    * using actions:  `this.path = 'global_app'` & `this.path = 'global_subscription'`
+  ```ruby
+    # SetUp a default app if Rents.test_env == true
+    def setup_default_app
+      # setup test_app path
+      self.path = 'global_app'
+  
+      # Get the App & setup config
+      app = get_json_request[:app]
+      Rents.app_id = app[:id]
+      Rents.secret_key = app[:secret]
+  
+      # Get the GlobalRecurrent & setup/config
+      self.path = 'global_subscription'
+      recurrence = get_json_request
+      self.recurrent_rid = recurrence[:rid]
+  
+      return puts 'Please run: rails g rents:install' if Rents.app_id.nil? || Rents.secret_key.nil?
+      self.auth = {app_id:Rents.app_id, secret_key:Rents.secret_key}
+      self.request_params.merge!(auth:self.auth)
+    end
+  ```
+  * `http_method_json`: return a simple HashMap
+  * `http_method`: return the complet request resp, with code (200, 404, 403...)
+  * `setup_attrs(params)` params = constructor_params, it method iterate the hash attrs & set it as obj attr
+  ```ruby
+    # Dynamic attributtes
+    params.each do |key, value|
+      next unless key.to_s.index('[]').nil?
+      self.class.__send__(:attr_accessor, :"#{key}")
+      self.__send__("#{key}=", value)
+    end
+  ```
+  * Methods: `this.get_json`, `this.post_json`, `this.get`, `this.post`
+  * Attributtes (the first option is __`test_env`__ the second is production):     
+  ```ruby
+    attr_accessor :auth = {app_id: '', app_secret: ''}
+    attr_accessor :path = ''
+    attr_accessor :domain = 'localhost:7000' || 'apprents.herokuapp.com'
+    attr_accessor :protocol = 'http' || 'https'
+    attr_accessor :end_point = this.protocol + "://" + this.domain + "api"
+    attr_accessor :api_version = 'v1'
+    attr_accessor :recurrent_rid = Rents.global_recurrence || rents_id,remote_id (rid)
+    attr_accessor :request_params = hash_received_on_constructor
+    attr_accessor :end_point_versioned = this.protocol + "://" + this.domain + "api" + this.api_version
+  ```
+  
+  

data/Gemfile

@@ -1,5 +1,6 @@
-source 'https://rubygems.org'
+ruby '2.1.2'
 #ruby=2.1.2@rentsgem
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rents.gemspec
-gemspec
+gemspec

data/README.md

@@ -22,6 +22,7 @@ TODO: Write usage instructions here
 
 ## Contributing
 
+0. Check our [__Contributing MarkDown explanation__](https://github.com/PageRentS/rents-sdk-ruby/blob/master/Contributing.md)
 1. Fork it ( https://github.com/[my-github-username]/rents/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/generators/templates/rents.rb

@@ -15,7 +15,7 @@ if Rails.env.development? || Rails.env.test?
   # TODO: Uncomment test_env if you want to test using RentS default & global app
   # Rents.test_env = true
   # TODO: Uncomment debugger if you have an RentS instance on your machine
-  # Rents.debugger = true
+  # Rents.debug = true
 elsif Rails.env.production?
   # TODO if using Rails 3 or older, put here your PRODUCTION app_id & your secret_key
   Rents.app_id = ''
@@ -23,11 +23,11 @@ elsif Rails.env.production?
 
   # For production remember to keep it false or just remove it
   Rents.test_env = false
-  Rents.debugger = false
+  Rents.debug = false
 end
 
 # Get your App config if your not using TEST_ENV nor DEBUGGER
-if (Rents.test_env.nil? && Rents.debugger.nil?) || (Rents.test_env == false && Rents.debugger == false)
+if (Rents.test_env.nil? && Rents.debug.nil?) || (Rents.test_env == false && Rents.debug == false)
   if Rails.version[0].to_i >= 4
     Rents.app_id = Rails.application.secrets.rents['app_id']
     Rents.secret_key = Rails.application.secrets.rents['app_secret_key']

data/lib/rents/array.rb

@@ -0,0 +1,6 @@
+class Array
+  # Convert string keys to symbol keys
+  def it_keys_to_sym
+    self.each_with_index {|element, i| element.is_a?(Hash) ? self[i] = element.it_keys_to_sym : next }
+  end
+end

data/lib/rents/config/enums/brands.yml

@@ -0,0 +1,45 @@
+brands:
+  # SampleObj
+- id:       0
+  name:     Nil
+  username: nil
+
+  # VISA
+- id:       1
+  name:     VISA
+  username: visa
+
+  # MasterCard
+- id:       2
+  name:     MasterCard
+  username: mastercard
+
+  # Diners Club
+- id:       3
+  name:     Diners Club
+  username: diners
+
+  # Discover
+- id:       4
+  name:     Discover
+  username: discover
+
+  # Elo
+- id:       5
+  name:     Elo
+  username: elo
+
+  # American Express
+- id:      6
+  name:     American Express
+  username: amex
+
+  # JCB
+- id:       7
+  name:     JCB
+  username: jcb
+
+  # Aura
+- id:       8
+  name:     Aura
+  username: aura

data/lib/rents/config/enums/currencies.yml

@@ -0,0 +1,35 @@
+currencies:
+  # SampleObj
+- id:         0
+  name:       Nil
+  acronym:    nil$
+  iso_code:   NIL
+  iso_number: 000
+
+  # Real
+- id:         1
+  name:       Real
+  acronym:    R$
+  iso_code:   BRL
+  iso_number: 986
+
+  # Euro
+- id:         2
+  name:       Euro
+  acronym:    €
+  iso_code:   EUR
+  iso_number: 978
+
+  # US Dollar
+- id:         3
+  name:       US Dollar
+  acronym:    US$
+  iso_code:   USD
+  iso_number: 840
+
+  # CAD Dollar
+- id:         4
+  name:       CAD Dollar
+  acronym:    CAD$
+  iso_code:   CAD
+  iso_number: 124

data/lib/rents/config/enums/payment_methods.yml

@@ -0,0 +1,20 @@
+payment_methods:
+  # SampleObj
+- id:   0
+  name: Nil
+
+  # Credit
+- id:   1
+  name: Credit
+
+  # Debit
+- id:   2
+  name: Debit
+
+  # Installments shop
+- id:   3
+  name: Installments shop
+
+  # Installments administrator
+- id:   4
+  name: Installments administrator

data/lib/rents/config/enums/recurrence_periods.yml

@@ -0,0 +1,18 @@
+recurrence_periods:
+  # Daily
+  daily:      1
+
+  # Weekly
+  weekly:     2
+
+  # Monthly
+  monthly:    3
+
+  # Bimonthly
+  bimonthly:  4
+
+  # Semiannual
+  semiannual: 5
+
+  # Annual
+  annual:     6

data/lib/rents/config/enums/transaction_codes.yml

@@ -0,0 +1,31 @@
+transaction_code:
+        0:
+          status: pending
+          msg: Transação Criada
+        1:
+          status: pending
+          msg: Transação em Andamento
+        2:
+          status: pending
+          msg: Transação Autenticada
+        3:
+          status: error
+          msg: Transação não Autenticada
+        4:
+          status: pending
+          msg: Transação Autorizada
+        5:
+          status: error
+          msg: Transação não Autorizada
+        6:
+          status: charged
+          msg: Transação Capturada
+        9:
+          status: error
+          msg: Transação Cancelada
+        10:
+          status: pending
+          msg: Transação em Autenticação
+        12:
+          status: pending
+          msg: Transação em Cancelamento

data/lib/rents/config/proxy.example.yml

@@ -0,0 +1,4 @@
+login:    your_login
+password: your_password
+host:     proxy_host
+port:     proxy_port

data/lib/rents/connection.rb

@@ -4,8 +4,10 @@ module Rents
     attr_accessor :auth
     attr_accessor :path
     attr_accessor :domain
+    attr_accessor :protocol
     attr_accessor :end_point
     attr_accessor :api_version
+    attr_accessor :recurrent_rid
     attr_accessor :request_params
     attr_accessor :end_point_versioned
 
@@ -13,20 +15,30 @@ module Rents
     def initialize(params = {})
       # An work around added to prevent a lot of changes
       params = params.merge({test_env:true}) if Rents.test_env
-      params = params.merge({debugger:true}) if Rents.debugger
+      params = params.merge({debug:true}) if Rents.debug
 
       # Static part
       self.request_params = {transaction:params}
-      setup_attrs(params)
       setup_config
       self.domain = 'apprents.herokuapp.com' # 'rents.pagerenter.com.br'
-      self.domain = 'localhost:7000' if params[:debugger]
+
+      # If using test or Debug it is not production
+      if params[:debug] || params[:test]
+        self.protocol = 'http'
+        self.domain = 'localhost:7000'
+      else
+        self.protocol = 'https'
+        self.domain = 'apprents.herokuapp.com'
+      end
+
       self.api_version = 'v1'
-      self.end_point = "http://#{self.domain}/api"
-      self.end_point_versioned = "http://#{self.domain}/api/#{self.api_version}"
+      self.end_point = "#{self.protocol}://#{self.domain}/api"
+      self.end_point_versioned = "#{self.protocol}://#{self.domain}/api/#{self.api_version}"
 
       # Dynamic env
       setup_default_app if params[:test_env]
+      setup_attrs(params)
+      self.recurrent_rid = params[:rid] unless params[:rid].nil?
     end
 
     # Full URL for the last request
@@ -34,27 +46,54 @@ module Rents
       "#{self.end_point}/#{self.api_version}/#{self.path}"
     end
 
-    # ============== HTTP REQUESTs METHODs ==============
-    # GET
+    # GET http
     def get_request
       RestClient.get self.url_requested
     end
 
+    # GET json
     def get_json_request
-      return JSON.parse(RestClient.get(self.url_requested)).it_keys_to_sym
+      resp = RestClient.get(self.url_requested)
+      to_hash_with_symbols(resp).it_keys_to_sym
     end
 
-    # POST
+    # POST http
     def post_request
       RestClient.post self.url_requested, self.request_params
     end
 
+    # POST json
     def post_json_request
-      return JSON.parse(RestClient.post(self.url_requested, self.request_params)).it_keys_to_sym
+      resp = RestClient.post(self.url_requested, self.request_params)
+      to_hash_with_symbols(resp)
+    end
+
+    # PUT http
+    def put_request
+      RestClient.put self.url_requested, self.request_params
+    end
+
+    # PUT json
+    def put_json_request
+      resp = RestClient.put(self.url_requested, self.request_params)
+      to_hash_with_symbols(resp)
+    end
+
+    # DELETE http
+    def delete_request
+      auth = self.request_params[:auth]
+      RestClient.delete self.url_requested, app_id:auth[:app_id], secret_key:auth[:secret_key]
+    end
+
+    # DELETE json
+    def delete_json_request
+      auth = self.request_params[:auth]
+      resp = RestClient.delete self.url_requested, auth_app_id:auth[:app_id], auth_secret_key:auth[:secret_key]
+      to_hash_with_symbols(resp)
     end
 
     # CALLBACKs
-    private
+    protected
       # Config Attrs
       def setup_config
         self.auth = {app_id:Rents.app_id, secret_key:Rents.secret_key}
@@ -71,6 +110,11 @@ module Rents
         Rents.app_id = app[:id]
         Rents.secret_key = app[:secret]
 
+        # Get the GlobalRecurrent & setup/config
+        self.path = 'global_subscription'
+        recurrence = get_json_request
+        self.recurrent_rid = recurrence[:rid]
+
         return puts 'Please run: rails g rents:install' if Rents.app_id.nil? || Rents.secret_key.nil?
         self.auth = {app_id:Rents.app_id, secret_key:Rents.secret_key}
         self.request_params.merge!(auth:self.auth)
@@ -86,12 +130,43 @@ module Rents
         end
       end
 
-      # HTTPs must have '[]' on it key name to send Array
+      # HTTP requests must have '[]' on it key name to send Array
       def custom_http_params
+        setup_format_and_validators
+
         return if self.sold_items.nil?
         self.sold_items.each_with_index do |sold_item, i|
           self.request_params[:transaction]["sold_items[#{i}]"] = sold_item
         end
       end
+
+      # Validate params to prevent errors like BAD Request & format values like value to Operator format
+      def setup_format_and_validators
+        validate_operator_format
+      end
+
+      # if necessary convert amount to operator value
+      def validate_operator_format
+        # prevent fatal error
+        return if self.amount.nil?
+
+        # aux vars
+        amount_str = self.amount.to_s
+        format_regex = /[.,]/
+
+        # if nil (it is not formatted, so it is not necessary to convert it format)
+        unless amount_str.match(format_regex).nil?
+          return if self.request_params.nil? || self.request_params[:transaction].nil?
+          self.amount = Rents::Currency.to_operator_str(self.amount)
+          self.request_params[:transaction][:amount] = self.amount
+        end
+      end
+    
+      # Return the JSON in a Hash with it keys in symbols
+      def to_hash_with_symbols json
+        hashed = JSON.parse(json)
+        hashed.is_a?(Array) ? hashed.each_with_index { |hash, i| hashed[i] = hash.it_keys_to_sym } : hashed.it_keys_to_sym
+        hashed
+      end
   end
 end

data/lib/rents/transaction.rb

@@ -45,21 +45,77 @@ module Rents
       self.resp
     end
 
-    # TODO create charge works like a buy_store
     # POST /api/transactions
     def charge_store full_resp=false
       custom_http_params
 
       # dynamic path (it is written when a specific method use it)
-      self.path = "transactions/store"
+      self.path = 'transactions/store'
 
       # using json_request because need only the answer (do not use something like it HTTP Code)
-      self.resp = self.post_json_request unless full_resp
-      self.resp = self.post_request if full_resp
+      full_resp ? self.resp = self.post_request : self.resp = self.post_json_request
+
+      # return it received resp
+      self.resp
+    end
+
+    # Update the recurrence amount
+    def update_subscription rid=nil, full_resp=false
+      # SetUp
+      self.recurrent_rid = rid if rid
+      self.path = "transactions/#{self.recurrent_rid}/subscription"
+
+      # Perform the request
+      full_resp ? self.resp = self.put_request : self.resp = self.put_json_request
+
+      # return it received resp
+      self.resp
+    end
+
+    # Stop a recurrence based on it transaction rid
+    def unsubscribe rid=nil, full_resp=false
+      # SetUp
+      self.recurrent_rid = rid if rid
+      self.path = "transactions/#{self.recurrent_rid}/subscription/unsubscribe"
+
+      # Perform the request
+      full_resp ? self.resp = self.delete_request : self.resp = self.delete_json_request
+
+      # return it received resp
+      self.resp
+    end
+
+    # Return the payments executed for the purchase passed
+    def payment_history rid=nil, full_resp=false
+      # SetUp
+      self.recurrent_rid = rid if rid
+      self.path = "transactions/#{self.recurrent_rid}/subscription/payment_history"
+      self.path = "#{self.path}#{self.request_params.it_keys_to_get_param}"
+
+      # Perform the request
+      full_resp ? self.resp = self.get_request : self.resp = self.get_json_request
+
+      # return it received resp
+      self.resp
+    end
+
+    # Check if a subscription is up-to-date or have any pending
+    def up_to_date rid=nil, full_resp=false
+      # SetUp
+      self.recurrent_rid = rid if rid
+
+      # Create/customize the path & add the auth as param
+      self.path = "transactions/#{self.recurrent_rid}/subscription/up-to-date"
+      self.path = "#{self.path}#{self.request_params.it_keys_to_get_param}"
+
+      # Perform the request
+      full_resp ? self.resp = self.get_request : self.resp = self.get_json_request
+
+      # return it received resp
       self.resp
     end
 
-    # ================ STATICs ================
+    # ================ STATIC methods ================
     # GET /api/transactions/:rid by the rid passed
     def self.find rid
     end

data/lib/rents/version.rb

@@ -1,6 +1,6 @@
 module Rents
   MAJOR = 1
   MINOR = 0
-  PATCH = 0
+  PATCH = 1
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end