paywhirl 0.0.3 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80caccf3ff8fe41563ee0c5c7c87d75dadf069286d2ce5a6e62a8805446168f6
-  data.tar.gz: b91299d1c63da76f141e9833012b9b985250b6c7290a938dca5d3eb8e72c6ba9
+  metadata.gz: 6cb5960d5d82ad63efac515fe1a21a54d6efb9455fd296c1ae86e359ae93765a
+  data.tar.gz: f73338c81bcffacc8000e81074924cb69c559d80405a45b0067d145884a9a87d
 SHA512:
-  metadata.gz: 59c442a50797e8fe5c14a7454b225ef070c9ab6930f0777912df1a25a1c878b4b965963cfb97a0017adc7402afd69d99851f553ccd1e913a1b47c5e137d6825c
-  data.tar.gz: ee286fbedf92320847e3abf3b8ecf6cffe3e0000a701e403eddf544ef3f548733750fe5fd591ee59e4b04d424a60d90f3cd5421b3023defc399fb5c38a5de865
+  metadata.gz: d9cf67de33cc2b75194240e550c5bc9b4a6697fe29b8b4484e61a3ecd4acdb329a9ead31a3e6d9fff4dbc6fe89a712c1b6daa6a2d4275726adc10badc65c3570
+  data.tar.gz: d22de0ea8acc5470ca818eda123b80d03bfa85cbfe2f507820498b2b8be9c618916a08332d4531be0aa97dcfc046c2bc546b3d7673b6a6b865405d2affce43b9

data/.gitignore

@@ -1,2 +1,4 @@
 *.lock
 *.gem
+/vendor
+/.bundle

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 400
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/ParameterLists:
+  Max: 10
+
+Naming/AccessorMethodName:
+  Enabled: false

data/Gemfile

@@ -1,6 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|Ruby PayWhirl Client| "https://github.com/paywhirl/ruby-pwclient" }
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in paywhirl.gemspec
 gemspec

data/README.md

@@ -25,7 +25,7 @@ functionality added, feel free to submit an issue or a pull request.
 
 ## Requirements
 
-- [Ruby] >= 1.9
+- [Ruby] >= 2.3
 - [Faraday](https://rubygems.org/gems/faraday)
 
 ## Installation

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "paywhirl"
+require 'bundler/setup'
+require 'paywhirl'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "paywhirl"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/paywhirl.rb

@@ -1,270 +1,291 @@
-# PayWhirl API Ruby Library
+# frozen_string_literal: true
+
+# PayWhirl API Client
 #
 # Documentation can be obtained at https://api.paywhirl.com
 #
 # API keys can be obtained at https://app.paywhirl.com/api-keys
 #
 # Example Usage:
-# ==================
-# <your_program>
-# require_relative 'PayWhirl'
+# ==============
+#
+# require 'paywhirl'
+#
 # api_key = '<your_api_key_here>'
 # api_secret = '<your_secret_key_here>'
+#
 # paywhirl = PayWhirl.new(api_key, api_secret)
-# paywhirl.<method>
-
+# puts paywhirl.get_account
+#
 
 require 'paywhirl/version'
 require 'json'
 require 'faraday'
 
-
+# PayWhirl API Client
 class PayWhirl
-  def initialize(api_key, api_secret, api_base="https://api.paywhirl.com")
-    @api_key = api_key.to_s
-    @api_secret = api_secret.to_s
-    @api_base = api_base.to_s
-    @headers = {:api_key => @api_key, :api_secret => @api_secret}
+  def initialize(api_key, api_secret, api_base = 'https://api.paywhirl.com')
+    @api_base = api_base
+    @headers = { api_key: api_key, api_secret: api_secret }
   end
 
+  def get_customers(params = {})
+    get('/customers', params)
+  end
 
-  def get_customers(data = nil)
-    return self.get('/customers', data)
+  def get_customer(customer_id)
+    get("/customer/#{customer_id}")
   end
 
-  def get_customer(customer_id = nil)
-    cust = "/customer/#{customer_id}"
-    return self.get(cust)
+  def get_addresses(customer_id)
+    get("/customer/addresses/#{customer_id}")
   end
 
-  def get_addresses(customer_id = nil)
-    cust = "/customer/addresses/#{customer_id}"
-    return self.get(cust)
+  def get_address(address_id)
+    get("/customer/address/#{address_id}")
   end
 
-  def get_address(address_id = nil)
-    cust = "/customer/address/#{address_id}"
-    return self.get(cust)
+  def get_profile(customer_id)
+    get("/customer/profile/#{customer_id}")
   end
 
-  def get_profile(customer_id = nil)
-    cust = "/customer/profile/#{customer_id}"
-    return self.get(cust)
+  def auth_customer(email, password)
+    post('/auth/customer', email: email, password: password)
   end
 
-  def create_customer(data = nil)
-    return self.post('/create/customer', data)
+  def create_customer(params)
+    post('/create/customer', params)
   end
 
-  def update_customer(data = nil)
-    return self.post('/update/customer', data)
+  def update_customer(params)
+    post('/update/customer', params)
   end
 
-  def update_answer(data = nil)
-    return self.post('/update/answer', data)
+  def delete_customer(id, forget = false)
+    params = { id: id, forget: forget ? '1' : nil }
+    post('/delete/customer', params)
   end
 
-  def get_questions(data = 100)
-    if data.respond_to?(:to_i)
-      data = {"limit" => data}
-    end
-    return self.get('/questions', data)
+  def get_questions(params_or_limit = 100)
+    params =
+      if params_or_limit.respond_to?(:to_i)
+        { limit: params_or_limit }
+      else
+        params_or_limit
+      end
+
+    get('/questions', params)
   end
 
-  def get_answers(data = nil)
-    if data.respond_to?(:to_i)
-      data = {"customer_id" => data}
-    end
-    return self.get('/answers', data)
+  def get_answers(params_or_customer_id)
+    params =
+      if params_or_customer_id.respond_to?(:to_i)
+        { customer_id: params_or_customer_id }
+      else
+        params_or_customer_id
+      end
+
+    get('/answers', params)
   end
 
-  def get_plans(data = nil)
-    return self.get('/plans', data)
+  def update_answer(params)
+    post('/update/answer', params)
   end
 
-  def get_plan(customer_id = nil)
-    plan = "/plan/#{customer_id}"
-    return self.get(plan)
+  def get_plans(params = {})
+    get('/plans', params)
   end
 
-  def create_plan(data = nil)
-    return self.post('/create/plan', data)
+  def get_plan(plan_id = nil)
+    get("/plan/#{plan_id}")
   end
 
-  def update_plan(data = nil)
-    return self.post('/update/plan', data)
+  def create_plan(params)
+    post('/create/plan', params)
   end
 
-  def get_subscriptions(customer_id = nil)
-    subs = "/subscriptions/#{customer_id}"
-    return self.get(subs)
+  def update_plan(params)
+    post('/update/plan', params)
   end
 
-  def get_subscription(customer_id = nil)
-    sub = "/subscription/#{customer_id}"
-    return self.get(sub)
+  def get_subscriptions(customer_id)
+    get("/subscriptions/#{customer_id}")
   end
 
-  def get_subscribers(data = nil)
-    return self.get('/subscribers', data)
+  def get_subscription(subscription_id)
+    get("/subscription/#{subscription_id}")
   end
 
-  def subscribe_customer(data = nil)
-    return self.post('/subscribe/customer', data)
+  def get_subscribers(params = {})
+    get('/subscribers', params)
   end
 
-  def update_subscription(subscription_id = nil, plan_id = nil, quantity = nil)
-    data = {'subscription_id'=>subscription_id, 'plan_id'=>plan_id}
-    if (quantity) then
-      data.merge!(quantity: quantity)
-    end
-    return self.post('/update/subscription', data)
+  def subscribe_customer(params)
+    post('/subscribe/customer', params)
   end
 
-  def unsubscribe_customer(subscription_id = nil)
-    data = {'subscription_id'=>subscription_id}
-    return self.post('/unsubscribe/customer', data)
+  def update_subscription(subscription_id, plan_id, quantity = nil,
+                          address_id: nil, installments_left: nil,
+                          trial_end: nil, card_id: nil)
+    params = {
+      subscription_id: subscription_id,
+      plan_id: plan_id
+    }
+
+    params[:quantity] = quantity if quantity
+    params[:address_id] = address_id if address_id
+    params[:installments_left] = installments_left if installments_left
+    params[:trial_end] = trial_end if trial_end
+    params[:card_id] = card_id if card_id
+
+    post('/update/subscription', params)
   end
 
-  def get_invoice(customer_id = nil)
-    format = "/invoice/#{customer_id}"
-    return self.get(format)
+  def unsubscribe_customer(subscription_id)
+    post('/unsubscribe/customer', subscription_id: subscription_id)
   end
 
-   def get_invoices(customer_id = nil, all_invoices = 0)
-    format = "/invoices/#{customer_id}/#{all_invoices}"
-    return self.get(format)
-   end
+  def get_invoices(customer_id, all_invoices = false)
+    get("/invoices/#{customer_id}", all: all_invoices ? '1' : nil)
+  end
 
-   def process_invoice(invoice_id = nil)
-    format = "/invoice/#{invoice_id}/process"
-    return self.post(format)
-   end
+  def get_invoice(invoice_id)
+    get("/invoice/#{invoice_id}")
+  end
 
-   def update_invoice_card(invoice_id = nil, card_id = nil)
-    data = {'card_id'=>card_id}
-    format = "/invoice/#{invoice_id}/card"
-    return self.post(format, data)
-   end
+  def process_invoice(invoice_id, params = {})
+    post("/invoice/#{invoice_id}/process", params)
+  end
 
-   def update_invoice_items(invoice_id = nil, line_items = nil)
-    format = "/invoice/#{invoice_id}/items"
-    return self.post(format, line_items)
-   end
+  def mark_invoice_as_paid(invoice_id)
+    post("/invoice/#{invoice_id}/mark-as-paid")
+  end
 
-   def create_invoice(data = nil)
-    format = "/invoices"
-    return self.post(format, data)
-   end
+  def add_promo_code_to_invoice(invoice_id, promo_code)
+    post("/invoice/#{invoice_id}/add-promo", promo_code: promo_code)
+  end
 
-   def get_gateways()
-     return self.get('/gateways')
-   end
+  def remove_promo_code_from_invoice(invoice_id)
+    post("/invoice/#{invoice_id}/remove-promo")
+  end
+
+  def update_invoice_card(invoice_id, card_id)
+    post("/invoice/#{invoice_id}/card", card_id: card_id)
+  end
+
+  def update_invoice_items(invoice_id, line_items = {})
+    post("/invoice/#{invoice_id}/items", line_items)
+  end
+
+  def create_invoice(params)
+    post('/invoices', params)
+  end
+
+  def delete_invoice(invoice_id)
+    post('/delete/invoice', id: invoice_id)
+  end
+
+  def get_gateways
+    get('/gateways')
+  end
+
+  def get_gateway(gateway_id)
+    get("/gateway/#{gateway_id}")
+  end
 
-   def get_gateway(customer_id = nil)
-     format = "/gateway/#{customer_id}"
-     return self.get(format)
-   end
+  def create_charge(params)
+    post('/create/charge', params)
+  end
 
-  def create_charge(data = nil)
-    return self.post('/create/charge', data)
+  def get_charge(charge_id)
+    get("/charge/#{charge_id}")
   end
 
-  def get_charge(customer_id = nil)
-    format = "/charge/#{customer_id}"
-    return self.get(format)
+  def refund_charge(charge_id, params = {})
+    post("/refund/charge/#{charge_id}", params)
   end
 
-  def get_card(customer_id = nil)
-    format = "/card/#{customer_id}"
-    return self.get(format)
+  def get_cards(customer_id)
+    get("/cards/#{customer_id}")
   end
 
-  def get_cards(customer_id = nil)
-    format = "/cards/#{customer_id}"
-    return self.get(format)
+  def get_card(card_id)
+    get("/card/#{card_id}")
   end
 
-  def create_card(data = nil)
-    return self.post('/create/card', data)
+  def create_card(params)
+    post('/create/card', params)
   end
 
-  def delete_card(customer_id = nil)
-    data = {'id'=>customer_id}
-    return self.post('/delete/card', data)
+  def delete_card(card_id)
+    post('/delete/card', id: card_id)
   end
 
-  def get_promos()
-    return self.get("/promo")
+  def get_promos
+    get('/promo')
   end
 
-  def get_promo(customer_id = nil)
-    format = "/promo/#{customer_id}"
-    return self.get(format)
+  def get_promo(promo_id)
+    get("/promo/#{promo_id}")
   end
 
-  def create_promo(data = nil)
-    return self.post('/create/promo', data)
+  def create_promo(params)
+    post('/create/promo', params)
   end
 
-  def delete_promo(promo_id = nil)
-    data = {'id'=>promo_id}
-    return self.post('/delete/promo', data)
+  def delete_promo(promo_id)
+    post('/delete/promo', id: promo_id)
   end
 
-  def get_email_template(customer_id = nil)
-    format = "/email/#{customer_id}"
-    return self.get(format)
+  def get_email_template(template_id)
+    get("/email/#{template_id}")
   end
 
-  def send_email(data = nil)
-    return self.post('/send-email', data)
+  def send_email(params)
+    post('/send-email', params)
   end
 
-  def get_account()
-    return self.get('/account')
+  def get_account
+    get('/account')
   end
 
-  def get_stats()
-    return self.get('/stats')
+  def get_stats
+    get('/stats')
   end
 
-  def get_shipping_rules()
-    return self.get("/shipping")
+  def get_shipping_rules
+    get('/shipping')
   end
 
-  def get_shipping_rule(customer_id = nil)
-    format = "/shipping/#{customer_id}"
-    return self.get(format)
+  def get_shipping_rule(shipping_rule_id)
+    get("/shipping/#{shipping_rule_id}")
   end
 
-  def get_tax_rule(customer_id = nil)
-    format = "/tax/#{customer_id}"
-    return self.get(format)
+  def get_tax_rules
+    get('/tax')
   end
 
-  def get_tax_rules()
-    return self.get('/tax')
+  def get_tax_rule(tax_rule_id)
+    get("/tax/#{tax_rule_id}")
   end
 
-  def get_multi_auth_token(data = nil)
-    return self.post('/multiauth', data)
+  def get_multi_auth_token(params)
+    post('/multiauth', params)
   end
 
-  def post(endpoint = nil, params = nil)
-    conn = Faraday.new(url: @api_base)
-    conn.headers = @headers
-    response = conn.post(endpoint, params)
-    json_object = JSON.parse(response.body)
-    return json_object
+  protected
+
+  def request(method, path, params = nil)
+    conn = Faraday.new(url: @api_base, headers: @headers)
+    response = conn.public_send(method, path, params)
+    JSON.parse(response.body)
   end
 
-  def get(endpoint = nil, params = nil)
-    conn = Faraday.new(url: @api_base)
-    conn.headers = @headers
-    response = conn.get(endpoint, params)
-    json_object = JSON.parse(response.body)
-    return json_object
+  def post(path, params = nil)
+    request(:post, path, params)
   end
 
+  def get(path, params = nil)
+    request(:get, path, params)
+  end
 end

data/lib/paywhirl/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paywhirl
-  VERSION = "0.0.3"
+  VERSION = '1.3'
 end

data/paywhirl.gemspec

@@ -1,31 +1,30 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "paywhirl/version"
+require 'paywhirl/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "paywhirl"
+  spec.name          = 'paywhirl'
   spec.version       = Paywhirl::VERSION
-  spec.authors       = ["PayWhirl"]
-  spec.email         = ["megrims@gmail.com"]
-  spec.required_ruby_version = ">= 1.9"
-  spec.summary       = %q{API library for simplifying interaction with PayWhirl services.}
-  spec.homepage      = "https://github.com/paywhirl/ruby-pwclient"
-  spec.license       = "MIT"
-  spec.description   = <<-EOF
-    This library provides an interface to manage your PayWhirl account from
-    within your own Ruby code.
-  EOF
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.authors       = ['PayWhirl']
+  spec.email         = ['developer@paywhirl.com']
+  spec.required_ruby_version = '>= 2.3'
+  spec.summary       = 'API library for simplifying interaction with PayWhirl services.'
+  spec.homepage      = 'https://github.com/paywhirl/ruby-pwclient'
+  spec.license       = 'MIT'
+  spec.description   = 'This library provides an interface to manage your ' \
+                       'PayWhirl account from within your own Ruby code.'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_runtime_dependency "faraday", "~> 0.13.1"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_runtime_dependency 'faraday', '~> 1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paywhirl
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: '1.3'
 platform: ruby
 authors:
 - PayWhirl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,43 +53,43 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
-description: |2
-      This library provides an interface to manage your PayWhirl account from
-      within your own Ruby code.
+        version: 1.0.0
+description: This library provides an interface to manage your PayWhirl account from
+  within your own Ruby code.
 email:
-- megrims@gmail.com
+- developer@paywhirl.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -97,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="