paypalrb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ae1273de94e65fd45aa8038f0776052d5658f2acdd8828e9230da2ab3a01ac5
+  data.tar.gz: 28b3602778a92e0ca0accb1951a5be82cfce028a51c9bba6a53a8f5c4be48787
+SHA512:
+  metadata.gz: 60d1ee06802fb3accd5bc8a1eb065b22188901f27cb1657fb4ab072ae76512b1466f6af4a7e26ce50e92a8ae4de114ccf3aaa961e6c9713e97106e2bf1f8eca8
+  data.tar.gz: e6a4858704fed4e564d78f13022d0dddd990987125e54e748a8518c421545771f80c1be210a815a80de43aa7e011882049e7681fa232cbaac8eabeb0f656cf59

data/.env.example

@@ -0,0 +1,3 @@
+CLIENT_ID=
+CLIENT_SECRET=
+ACCESS_TOKEN=

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in youtuberb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    paypalrb (0.1.1)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  paypalrb!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dean Perry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# PayPalRB
+
+**This library is a work in progress**
+
+PayPalRB is a Ruby library for interacting with the PayPal API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paypalrb'
+```
+
+## Usage
+
+### Generate an Access Token
+
+Firstly you'll need to generate an Access Token. Set the Client ID and Secret
+An Access Token will be an OAuth2 token generated after authentication. 
+
+
+```ruby
+@authentication = PayPal::Authentication.new(client_id: "", client_secret: "")
+
+@authentication.get_token
+# =>  #<PayPal::AccessToken access_token="abc123", expires_in=123 
+```
+
+Then once you have an access token, set it like so:
+
+```ruby
+@client = PayPal::Client.new(access_token: "abc123")
+```
+
+### Products
+
+```ruby
+# Retrieve a list of products
+@client.products.list
+
+# Retrieve a product by its ID
+@client.products.retrieve id: "123"
+
+# Create a product
+# Type should be physical, digital or service
+# Docs: https://developer.paypal.com/docs/api/catalog-products/v1/#products_create
+@client.products.create name: "My Product", type: ""
+```
+
+### Orders
+
+```ruby
+# Retrieves an Order
+@client.orders.retrieve id: "abc123"
+
+# Creates an Order
+# Intent should be either capture or authorize
+# Items is an array of purchase units
+# Docs: https://developer.paypal.com/docs/api/orders/v2/#orders_create
+@client.orders.create intent: "capture", items: []
+
+# As above but creates an order for the total of value given
+@client.orders.create_payment intent: "capture", description: "A Payment",
+  currency: "GBP", value: "25.00"
+
+# As above but creates an order for a single item
+@client.orders.create_single intent: "capture", title: "Item Title",
+  description: "Item Description", currency: "GBP", value: "25.00"
+
+# Authorizes payment for an order. The buyer must first approve the order.
+@client.orders.authorize id: "123abc"
+
+# Captures payment for an order. The buyer must first approve the order.
+@client.orders.capture id: "123abc"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/paypalrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pay_pal"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+@authentication = PayPal::Authentication.new(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
+
+@client = PayPal::Client.new(access_token: ENV["ACCESS_TOKEN"])
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pay_pal/authentication.rb

@@ -0,0 +1,31 @@
+module PayPal
+  class Authentication
+
+    attr_reader :client_id, :client_secret, :sandbox
+
+    def initialize(client_id:, client_secret:, sandbox: true, adapter: Faraday.default_adapter)
+      @client_id = client_id
+      @client_secret = client_secret
+      @sandbox = sandbox
+      @adapter = adapter
+    end
+
+    def get_token
+      if @sandbox
+        url = "https://api-m.sandbox.paypal.com"
+      else
+        url = "https://api-m.paypal.com"
+      end
+
+      request_helper = Faraday.new(url: url) do |conn|
+        conn.request :authorization, :basic, client_id, client_secret
+      end
+
+      response = request_helper.post "/v1/oauth2/token?grant_type=client_credentials"
+
+      body = JSON.parse(response.body)
+      AccessToken.new(body)
+    end
+
+  end
+end

data/lib/pay_pal/client.rb

@@ -0,0 +1,36 @@
+module PayPal
+  class Client
+    attr_reader :access_token, :sandbox, :adapter
+
+    def initialize(access_token:, sandbox: true, adapter: Faraday.default_adapter, stubs: nil)
+      @access_token = access_token
+      @sandbox = sandbox
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def products
+      ProductsResource.new(self)
+    end
+
+    def orders
+      OrdersResource.new(self)
+    end
+
+    def connection
+      url = @sandbox ? "https://api-m.sandbox.paypal.com" : "https://api-m.paypal.com"
+
+      @connection ||= Faraday.new(url) do |conn|
+        conn.request :authorization, :Bearer, access_token
+        conn.request :json
+
+        conn.response :json
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+  end
+end

data/lib/pay_pal/collection.rb

@@ -0,0 +1,24 @@
+module PayPal
+  class Collection
+    attr_reader :data, :total, :next_page_token, :prev_page_token
+
+    def self.from_response(response, kind:, type:)
+      body = response.body
+
+      new(
+        data: body[kind].map { |attrs| type.new(attrs) },
+        total: body["pageInfo"],
+        next_page_token: body["nextPageToken"],
+        prev_page_token: body["prevPageToken"],
+        # cursor: body.dig("pagination", "cursor")
+      )
+    end
+
+    def initialize(data:, total:, next_page_token:, prev_page_token:)
+      @data = data
+      @total = total
+      @next_page_token = next_page_token
+      @prev_page_token = prev_page_token
+    end
+  end
+end

data/lib/pay_pal/error.rb

@@ -0,0 +1,4 @@
+module PayPal
+  class Error < StandardError
+  end
+end

data/lib/pay_pal/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module PayPal
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/pay_pal/objects/access_token.rb

@@ -0,0 +1,4 @@
+module PayPal
+  class AccessToken < Object
+  end
+end

data/lib/pay_pal/objects/order.rb

@@ -0,0 +1,13 @@
+module PayPal
+  class Order < Object
+   
+    # def initialize(options = {})
+    #   options.delete "links"
+
+    #   super options
+
+    #   self.url = "https://www.sandbox.paypal.com/checkoutnow?token=#{options['id']}"
+    # end
+    
+  end
+end

data/lib/pay_pal/objects/product.rb

@@ -0,0 +1,11 @@
+module PayPal
+  class Product < Object
+   
+    def initialize(options = {})
+      options.delete "links"
+
+      super options
+    end
+    
+  end
+end

data/lib/pay_pal/resource.rb

@@ -0,0 +1,56 @@
+module PayPal
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body}'"
+      when 404
+        raise Error, "Error 404: No results were found for your request. '#{response.body}'"
+      when 409
+        raise Error, "Error 409: Your request was a conflict. '#{response.body}'"
+      when 422
+        raise Error, "Error 422: Unprocessable Entity. '#{response.body}'"
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body}'"
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body}'"
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body}'"
+      end
+
+      response
+    end
+  end
+end

data/lib/pay_pal/resources/orders.rb

@@ -0,0 +1,65 @@
+module PayPal
+  class OrdersResource < Resource
+
+    def retrieve(id:)
+      response = get_request("v2/checkout/orders/#{id}")
+      Order.new(response.body)
+    end
+    
+    def create(intent:, units:, **params)
+      attributes = {intent: intent.upcase, purchase_units: units}
+      Order.new post_request("v2/checkout/orders", 
+        body: attributes.merge(params),
+        headers: {"Prefer" => "return=representation"}
+      ).body
+    end
+
+    def create_payment(intent:, description:, currency:, value:, **params)
+      items = [{
+        description: description,
+        amount: {
+          currency_code: currency, value: value
+        }
+      }]
+
+      attributes = {intent: intent.upcase, purchase_units: items}
+      Order.new post_request("v2/checkout/orders", 
+        body: attributes.merge(params),
+        headers: {"Prefer" => "return=representation"}
+      ).body
+    end
+
+    def create_single(intent:, title:, description:, currency:, value:, **params)
+      items = [{
+        items: [
+          {name: title, description: description, quantity: 1, unit_amount: {currency_code: currency, value: value}}
+        ],
+        amount: {
+          currency_code: currency, value: value,
+          breakdown: {
+            item_total: {
+              currency_code: currency, value: value
+            }
+          }
+        }
+      }]
+
+      attributes = {intent: intent.upcase, purchase_units: items}
+      Order.new post_request("v2/checkout/orders", 
+        body: attributes.merge(params),
+        headers: {"Prefer" => "return=representation"}
+      ).body
+    end
+
+    def authorize(id:)
+      response = post_request("v2/checkout/orders/#{id}/authorize", body: {})
+      Order.new(response.body)
+    end
+
+    def capture(id:)
+      response = post_request("v2/checkout/orders/#{id}/capture", body: {})
+      Order.new(response.body)
+    end
+
+  end
+end

data/lib/pay_pal/resources/products.rb

@@ -0,0 +1,20 @@
+module PayPal
+  class ProductsResource < Resource
+
+    def list
+      response = get_request("v1/catalogs/products")
+      Collection.from_response(response, kind: "products", type: Product)
+    end
+
+    def retrieve(id:)
+      response = get_request("v1/catalogs/products/#{id}")
+      Product.new(response.body)
+    end
+    
+    def create(name:, type:, **params)
+      attributes = {name: name, type: type}
+      Product.new post_request("v1/catalogs/products", body: attributes.merge(params)).body
+    end
+
+  end
+end

data/lib/pay_pal/version.rb

@@ -0,0 +1,3 @@
+module PayPal
+  VERSION = "0.1.1"
+end

data/lib/pay_pal.rb

@@ -0,0 +1,23 @@
+require "faraday"
+require "json"
+
+require_relative "pay_pal/version"
+
+module PayPal
+
+  autoload :Client, "pay_pal/client"
+  autoload :Collection, "pay_pal/collection"
+  autoload :Error, "pay_pal/error"
+  autoload :Resource, "pay_pal/resource"
+  autoload :Object, "pay_pal/object"
+  
+  autoload :Authentication, "pay_pal/authentication"
+
+  autoload :ProductsResource, "pay_pal/resources/products"
+  autoload :OrdersResource, "pay_pal/resources/orders"
+
+  autoload :AccessToken, "pay_pal/objects/access_token"
+  autoload :Product, "pay_pal/objects/product"
+  autoload :Order, "pay_pal/objects/order"
+
+end

data/lib/paypalrb.rb

@@ -0,0 +1 @@
+require "pay_pal"

data/paypalrb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/pay_pal/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "paypalrb"
+  spec.version = PayPal::VERSION
+  spec.authors = ["Dean Perry"]
+  spec.email = ["dean@deanpcmad.com"]
+
+  spec.summary = "A Ruby library for interacting with the PayPal API"
+  spec.homepage = "https://deanpcmad.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/paypalrb"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: paypalrb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pay_pal.rb
+- lib/pay_pal/authentication.rb
+- lib/pay_pal/client.rb
+- lib/pay_pal/collection.rb
+- lib/pay_pal/error.rb
+- lib/pay_pal/object.rb
+- lib/pay_pal/objects/access_token.rb
+- lib/pay_pal/objects/order.rb
+- lib/pay_pal/objects/product.rb
+- lib/pay_pal/resource.rb
+- lib/pay_pal/resources/orders.rb
+- lib/pay_pal/resources/products.rb
+- lib/pay_pal/version.rb
+- lib/paypalrb.rb
+- paypalrb.gemspec
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/paypalrb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A Ruby library for interacting with the PayPal API
+test_files: []