Merge pull request #56 from PaymentRails/dev

[DEVREL-11] Ruby SDK Gap Updates

Author: Aman Aalam

.gitignore

@@ -3,7 +3,6 @@ rdoc
 *.gem
 tags
 .rvmrc
-Gemfile.lock
 .idea
 .bundle
 vendor

.rubocop.yml

@@ -3,7 +3,7 @@ inherit_from: .rubocop_todo.yml
 # This basically enshrines existing intentional styles
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
@@ -19,3 +19,6 @@ Style/CaseEquality:
 
 Style/Documentation:
   Enabled: false
+
+Naming/MethodName:
+  Enabled: false

.rubocop_todo.yml

@@ -12,23 +12,23 @@
 # SupportedStyles: around, only_before
 Layout/EmptyLinesAroundAccessModifier:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
+    - 'lib/trolley/Client.rb'
 
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
 Layout/EmptyLinesAroundClassBody:
   Exclude:
-    - 'lib/paymentrails/Configuration.rb'
-    - 'lib/paymentrails/gateways/BalanceGateway.rb'
+    - 'lib/trolley/Configuration.rb'
+    - 'lib/trolley/gateways/BalanceGateway.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
 Layout/ExtraSpacing:
   Exclude:
-    - 'lib/paymentrails/gateways/BalanceGateway.rb'
+    - 'lib/trolley/gateways/BalanceGateway.rb'
 
 # Offense count: 2
 # Cop supports --auto-correct.
@@ -38,21 +38,21 @@ Layout/ExtraSpacing:
 # SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
 Layout/HashAlignment:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
+    - 'lib/trolley/Client.rb'
 
 # Offense count: 10
 # Cop supports --auto-correct.
 # Configuration parameters: Width, IgnoredPatterns.
 Layout/IndentationWidth:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
-    - 'lib/paymentrails/Exceptions.rb'
+    - 'lib/trolley/Client.rb'
+    - 'lib/trolley/Exceptions.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 Layout/SpaceBeforeComma:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
+    - 'lib/trolley/Client.rb'
 
 # Offense count: 2
 # Cop supports --auto-correct.
@@ -61,23 +61,23 @@ Layout/SpaceBeforeComma:
 # SupportedStylesForEmptyBraces: space, no_space
 Layout/SpaceInsideHashLiteralBraces:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
+    - 'lib/trolley/Client.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: space, no_space
 Layout/SpaceInsideParens:
   Exclude:
-    - 'lib/paymentrails/gateways/BalanceGateway.rb'
+    - 'lib/trolley/gateways/BalanceGateway.rb'
 
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: IndentationWidth.
-Layout/Tab:
+Layout/IndentationStyle:
   Exclude:
-    - 'lib/paymentrails/Batch.rb'
-    - 'lib/paymentrails/RecipientAccount.rb'
+    - 'lib/trolley/Batch.rb'
+    - 'lib/trolley/RecipientAccount.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -90,7 +90,7 @@ Layout/TrailingWhitespace:
 # Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
 Lint/UselessAccessModifier:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
+    - 'lib/trolley/Client.rb'
 
 # Offense count: 11
 Metrics/AbcSize:
@@ -119,23 +119,23 @@ Naming/BlockParameterName:
 # SupportedStyles: snake_case, camelCase
 Naming/MethodName:
   Exclude:
-    - 'lib/paymentrails/Configuration.rb'
+    - 'lib/trolley/Configuration.rb'
 
 # Offense count: 8
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: io, id, to, by, on, in, at, ip, db, os
 Naming/MethodParameterName:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
-    - 'lib/paymentrails/Configuration.rb'
+    - 'lib/trolley/Client.rb'
+    - 'lib/trolley/Configuration.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
 Style/ConditionalAssignment:
   Exclude:
-    - 'lib/paymentrails/gateways/OfflinePaymentGateway.rb'
+    - 'lib/trolley/gateways/OfflinePaymentGateway.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -154,14 +154,14 @@ Style/FrozenStringLiteralComment:
 # Cop supports --auto-correct.
 Style/IfUnlessModifier:
   Exclude:
-    - 'lib/paymentrails/Client.rb'
+    - 'lib/trolley/Client.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
   Exclude:
-    - 'lib/paymentrails.rb'
+    - 'lib/trolley.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -177,7 +177,7 @@ Style/SpecialGlobalVars:
 Style/StringLiterals:
   Exclude:
     - 'Gemfile'
-    - 'lib/paymentrails/Client.rb'
+    - 'lib/trolley/Client.rb'
     - 'paymentrails.gemspec'
 
 # Offense count: 49

Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    trolley (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    dotenv (2.8.1)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    power_assert (2.0.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.49.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    test-unit (3.5.7)
+      power_assert
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv (~> 2)
+  rake (~> 13)
+  rubocop (~> 1)
+  test-unit (~> 3)
+  trolley!
+
+BUNDLED WITH
+   2.3.22

README.md

@@ -1,11 +1,9 @@
-# Trolley Ruby SDK (Previously Payment Rails[^1])
+# Trolley Ruby SDK
 
 [![Latest Stable Version](https://poser.pugx.org/paymentrails/ruby-sdk/v/stable.png)](https://packagist.org/packages/paymentrails/ruby-sdk)
 
 The Trolley Ruby SDK provides integration access to the Trolley API.
 
-[^1]: [Payment Rails is now Trolley](https://www.trolley.com/payment-rails-is-now-trolley-series-a). We're in the process of updating our SDKs to support the new domain. In this transition phase, you might still see "PaymentRails" at some places.
-
 ## Requirements
 
 Ruby version >= 2.4 is required.
@@ -16,7 +14,7 @@ Bundler is required.
 ### Install the Gem
 
 ```bash
-gem install paymentrails
+gem install trolley
 ```
 
 ## Installation & Usage (Git)
@@ -32,8 +30,8 @@ git clone https://github.com/PaymentRails/ruby-sdk.git
 ```bash
 cd ruby-sdk
 bundler install
-gem build paymentrails.gemspec
-gem install paymentrails-[version].gem
+gem build trolley.gemspec
+gem install trolley-[version].gem
 ```
 
 ### Running Tests
@@ -49,20 +47,24 @@ bundle exec ruby spec/integration/RecipientTest.rb
 
 ## Getting Started
 
-```Ruby
-
-require 'paymentrails'
+```ruby
+require 'trolley'
 
-client = PaymentRails.client('YOUR-API-KEY', 'YOUR-SECRET-KEY')
+client = Trolley.client('ACCESS-KEY', 'SECRET-KEY')
 
 recipient = client.recipient.find('R-1234567abcdefg')
 print recipient.id
 ```
 
-#### Need a proxy?
+#### Configuring a proxy
 
 ```Ruby
-client = PaymentRails.client('YOUR-API-KEY', 'YOUR-SECRET-KEY', 'production', proxy_uri: 'peter_the_proxy.com')
+client = Trolley.client('ACCESS-KEY', 'SECRET-KEY', proxy_uri: 'peter_the_proxy.com')
+```
+
+### Configuring a custom base API URL
+```ruby
+client = Trolley.client('key', 'secret', api_base: 'https://api.railz.io')
 ```
 
 ## Documentation for API Endpoints