paypal-sdk-rest 0.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2RlZWM2YmZkOGMwNWUxYzM4MjE3MmY4YjIyZmY3OTgyNzk0ZmY0OA==
+  data.tar.gz: !binary |-
+    NzI0YmMyNTM5ZTNjYjQxYzlmOTFjNDBkMzk1ZTQ2N2U0NTE1NjMyNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTM3MDgxZjQyMjkxZDcyYTkwYWJhZGI2ZjFmZTFiM2RhNzYzMmUxODE1NGQx
+    NWM4NzYzOWRkYjlhOWFiMmRiMjkxMmI1NGQwMjMwYjExZDg0NjdmNWQ5YWEy
+    MzQ0YjExYTBjMDEzNGNjNjY4ZGYzMTk5OTZmNGI3YmM0NzY1Yzg=
+  data.tar.gz: !binary |-
+    MmZhMjVjYmE0NmI2N2Q4NTBiZGI3NjgyM2ExMjZmYmNiMGFjNjA4NGEzNTEw
+    YjYzMDFmZTVjZTBkNmViNWE3ZjU4NTk5YTRiNjM1OTY5ZGU1OTYzMTNhMzEy
+    YmRjMTY2ZjI4OGJjYjk2OGM1YWM3YThmNDYwYzMwNDRlOGEyMDM=

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'paypal-sdk-core', :git => "https://github.com/paypal/sdk-core-ruby.git"
+
+gem 'rake', :require => false
+
+group :test do
+  gem 'simplecov', :require => false
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,136 @@
+# REST SDK
+
+The PayPal REST SDK provides Ruby APIs to create, process and manage rest.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paypal-sdk-rest'
+
+    # gem 'paypal-sdk-core', :git => "https://github.com/paypal/sdk-core-ruby.git"
+    # gem 'paypal-sdk-rest', :git => "https://github.com/paypal/rest-api-sdk-ruby.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paypal-sdk-rest
+
+## Configuration
+
+For Rails application:
+
+    rails g paypal:sdk:install
+
+For other ruby application, create a configuration file(`config/paypal.yml`):
+
+    development: &default
+      client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
+      client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
+      mode: sandbox
+      # # with Proxy
+      # http_proxy: http://proxy-ipaddress:3129/
+      # # with CA File
+      # ssl_options:
+      #   ca_file: config/cacert.pem
+      # # Override Endpoint
+      # rest_endpoint: https://api.sandbox.paypal.com
+    test:
+      <<: *default
+    production:
+      <<: *default
+      mode: live
+
+
+Load Configurations from specified file:
+
+    PayPal::SDK::Core::Config.load('spec/config/paypal.yml',  ENV['RACK_ENV'] || 'development')
+
+Without configuration file:
+
+    PayPal::SDK::REST.set_config(
+      :client_id => "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
+      :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM",
+      :mode => "sandbox", # "sandbox" or "live"
+      :ssl_options => { } )
+
+Override configuration:
+
+    # Class level
+    Payment.set_config( :client_id => "123" )
+
+    # Object level
+    payment.set_config( :client_id => "123" )
+
+
+## Create Payment
+
+```ruby
+require 'paypal-sdk-rest'
+include PayPal::SDK::REST
+
+PayPal::SDK::REST.set_config(
+  :client_id => "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
+  :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM",
+  :mode => "sandbox" )
+
+# Build Payment object
+@payment = Payment.new({
+  :intent => "sale",
+  :payer => {
+    :payment_method => "credit_card",
+    :funding_instruments => [{
+      :credit_card => {
+        :type => "visa",
+        :number => "4417119669820331",
+        :expire_month => "11",
+        :expire_year => "2018",
+        :cvv2 => "874",
+        :first_name => "Joe",
+        :last_name => "Shopper",
+        :billing_address => {
+          :line1 => "52 N Main ST",
+          :city => "Johnstown",
+          :state => "OH",
+          :postal_code => "43210",
+          :country_code => "US" }}}]},
+  :transactions => [{
+    :amount => {
+      :total => "1.00",
+      :currency => "USD" },
+    :description => "This is the payment transaction description." }]})
+
+# Make API call & get response
+if @payment.create
+  @payment.id     # Payment Id
+else
+  @payment.error  # Error Hash
+end
+```
+
+## Get Payment
+
+```ruby
+# Fetch Payment
+payment = Payment.find("PAY-57363176S1057143SKE2HO3A")
+
+# Get List of REST
+payment_history = Payment.all( :count => 10 )
+
+payment_history.payments
+```
+
+## Execute Payment
+
+```ruby
+payment = Payment.find("PAY-57363176S1057143SKE2HO3A")
+
+if payment.execute( :payer_id => "DUFRQ8GWYMJXC" )
+  # Success Message
+else
+  payment.error # Error Hash
+end
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+desc "Run tests"
+task :rspec do
+  cmd = "bundle exec rspec"
+  system(cmd) || raise("#{cmd} failed")
+end
+
+task :default => :rspec

data/lib/paypal-sdk-rest.rb

@@ -0,0 +1,2 @@
+require "paypal-sdk/rest"
+

data/lib/paypal-sdk/rest.rb

@@ -0,0 +1,38 @@
+require 'paypal-sdk-core'
+
+module PayPal
+  module SDK
+    module REST
+      autoload :VERSION,   "paypal-sdk/rest/version"
+      autoload :DataTypes, "paypal-sdk/rest/data_types"
+      autoload :API,       "paypal-sdk/rest/api"
+      autoload :RequestDataType,  "paypal-sdk/rest/request_data_type"
+      autoload :SetAPI,           "paypal-sdk/rest/set_api"
+      autoload :GetAPI,           "paypal-sdk/rest/get_api"
+      autoload :ErrorHash,        "paypal-sdk/rest/error_hash"
+
+      include DataTypes
+      include Core::Exceptions
+
+      module ClassMethods
+        def method_missing(name, *args)
+          RequestDataType.send(name, *args)
+        end
+      end
+
+      class << self
+        def new(*args)
+          API.new(*args)
+        end
+        include ClassMethods
+
+        def included(klass)
+          if klass.is_a? Module
+            klass.extend(ClassMethods)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/paypal-sdk/rest/api.rb

@@ -0,0 +1,23 @@
+require 'paypal-sdk-core'
+
+module PayPal
+  module SDK
+    module REST
+      class API < Core::API::REST
+#        include Services
+
+        def initialize(environment = nil, options = {})
+          super("", environment, options)
+        end
+
+        class << self
+          def user_agent
+            @user_agent ||= "PayPalSDK/rest-sdk-ruby #{VERSION} (paypal-sdk-core #{PayPal::SDK::Core::VERSION}; ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM})"
+          end
+        end
+
+      end
+    end
+  end
+end
+

data/lib/paypal-sdk/rest/data_types.rb

@@ -0,0 +1,420 @@
+# Stub objects for REST
+# Auto generated code
+
+require 'uuidtools'
+
+require 'paypal-sdk-core'
+
+module PayPal::SDK
+  module REST
+    module DataTypes
+
+      class DataType < Core::API::DataTypes::Base
+        attr_accessor :error
+        attr_writer   :header, :request_id
+
+        def header
+          @header ||= {}
+        end
+
+        def request_id
+          @request_id ||= UUIDTools::UUID.random_create.to_s
+        end
+
+        def http_header
+          { "PayPal-Request-Id" => request_id.to_s }.merge(header)
+        end
+
+        def success?
+          @error.nil?
+        end
+
+        def merge!(values)
+          @error = nil
+          super
+        end
+
+        def self.load_members
+        end
+      end
+
+      class Resource < DataType
+      end
+
+      class EnumType < Core::API::DataTypes::Enum
+      end
+
+      class Refund < Resource
+        def self.load_members
+          object_of :id, String
+          object_of :create_time, String
+          object_of :update_time, String
+          object_of :state, String
+          object_of :amount, Amount
+          object_of :sale_id, String
+          object_of :capture_id, String
+          object_of :parent_payment, String
+          object_of :description, String
+          array_of :links, Link
+        end
+
+        include RequestDataType
+
+        class << self
+          def find(refundid)
+            raise ArgumentError.new("refundid required") if refundid.to_s.strip.empty?
+            url = sprintf("v1/payments/refund/%s", refundid.to_s.strip)
+            response = api.get(url)
+            new(response)
+          end
+        end
+      end
+
+
+
+      class Resource < DataType
+        def self.load_members
+        end
+      end
+
+
+
+      class Amount < Resource
+        def self.load_members
+          object_of :total, String
+          object_of :currency, String
+          object_of :details, AmountDetails
+        end
+      end
+
+
+
+      class AmountDetails < Resource
+        def self.load_members
+          object_of :subtotal, String
+          object_of :tax, String
+          object_of :shipping, String
+          object_of :fee, String
+        end
+      end
+
+
+
+      class Link < Resource
+        def self.load_members
+          object_of :href, String
+          object_of :rel, String
+          object_of :method, String
+        end
+      end
+
+
+
+      class Payment < Resource
+        def self.load_members
+          object_of :id, String
+          object_of :create_time, String
+          object_of :update_time, String
+          object_of :state, String
+          object_of :intent, String
+          object_of :payer, Payer
+          array_of :transactions, Transaction
+          object_of :redirect_urls, RedirectUrls
+          array_of :links, Link
+        end
+
+        include RequestDataType
+
+        class << self
+          def all(options = {})
+            url = "v1/payments/payment"
+            response = api.get(url, options)
+            PaymentHistory.new(response)
+          end
+        end
+
+        def create()
+          url = "v1/payments/payment"
+          response = api.post(url, self.to_hash, self.http_header)
+          self.merge!(response)
+          success?
+        end
+
+        class << self
+          def find(paymentid)
+            raise ArgumentError.new("paymentid required") if paymentid.to_s.strip.empty?
+            url = sprintf("v1/payments/payment/%s", paymentid.to_s.strip)
+            response = api.get(url)
+            new(response)
+          end
+        end
+
+        def execute(payment_execution)
+          raise ArgumentError.new("id required") if self.id.to_s.strip.empty?
+          url = sprintf("v1/payments/payment/%s/execute", self.id.to_s.strip)
+          payment_execution = PaymentExecution.new(payment_execution) unless payment_execution.is_a? PaymentExecution
+          response = api.post(url, payment_execution.to_hash, payment_execution.http_header)
+          self.merge!(response)
+          success?
+        end
+      end
+
+
+
+      class Payer < Resource
+        def self.load_members
+          object_of :payment_method, String
+          object_of :payer_info, PayerInfo
+          array_of :funding_instruments, FundingInstrument
+        end
+      end
+
+
+
+      class PayerInfo < Resource
+        def self.load_members
+          object_of :email, String
+          object_of :first_name, String
+          object_of :last_name, String
+          object_of :payer_id, String
+          object_of :shipping_address, Address
+          object_of :phone, String
+        end
+      end
+
+
+
+      class Address < Resource
+        def self.load_members
+          object_of :line1, String
+          object_of :line2, String
+          object_of :city, String
+          object_of :state, String
+          object_of :postal_code, String
+          object_of :country_code, String
+          object_of :type, String
+          object_of :phone, String
+        end
+      end
+
+
+
+      class FundingInstrument < Resource
+        def self.load_members
+          object_of :credit_card, CreditCard
+          object_of :credit_card_token, CreditCardToken
+        end
+      end
+
+
+
+      class CreditCard < Resource
+        def self.load_members
+          object_of :id, String
+          object_of :valid_until, String
+          object_of :state, String
+          object_of :payer_id, String
+          object_of :type, String
+          object_of :number, String
+          object_of :expire_month, String
+          object_of :expire_year, String
+          object_of :cvv2, String
+          object_of :first_name, String
+          object_of :last_name, String
+          object_of :billing_address, Address
+          array_of :links, Link
+        end
+
+        include RequestDataType
+
+        def create()
+          url = "v1/vault/credit-card"
+          response = api.post(url, self.to_hash, self.http_header)
+          self.merge!(response)
+          success?
+        end
+
+        class << self
+          def find(creditcardid)
+            raise ArgumentError.new("creditcardid required") if creditcardid.to_s.strip.empty?
+            url = sprintf("v1/vault/credit-card/%s", creditcardid.to_s.strip)
+            response = api.get(url)
+            new(response)
+          end
+        end
+      end
+
+
+
+      class CreditCardToken < Resource
+        def self.load_members
+          object_of :credit_card_id, String
+          object_of :payer_id, String
+        end
+      end
+
+
+
+      class Transaction < Resource
+        def self.load_members
+          object_of :amount, Amount
+          object_of :payee, Payee
+          object_of :description, String
+          object_of :item_list, ItemList
+          array_of :related_resources, SubTransaction
+        end
+      end
+
+
+
+      class Payee < Resource
+        def self.load_members
+          object_of :merchant_id, String
+          object_of :email, String
+          object_of :phone, String
+        end
+      end
+
+
+
+      class ItemList < Resource
+        def self.load_members
+          array_of :items, Item
+          object_of :shipping_address, ShippingAddress
+        end
+      end
+
+
+
+      class Item < Resource
+        def self.load_members
+          object_of :name, String
+          object_of :sku, String
+          object_of :price, String
+          object_of :currency, String
+          object_of :quantity, String
+        end
+      end
+
+
+
+      class ShippingAddress < Address
+        def self.load_members
+          object_of :recipient_name, String
+        end
+      end
+
+
+
+      class SubTransaction < Resource
+        def self.load_members
+          object_of :sale, Sale
+          object_of :authorization, Authorization
+          object_of :refund, Refund
+          object_of :capture, Capture
+        end
+      end
+
+
+
+      class Sale < Resource
+        def self.load_members
+          object_of :id, String
+          object_of :create_time, String
+          object_of :update_time, String
+          object_of :state, String
+          object_of :amount, Amount
+          object_of :parent_payment, String
+          array_of :links, Link
+        end
+
+        include RequestDataType
+
+        class << self
+          def find(saleid)
+            raise ArgumentError.new("saleid required") if saleid.to_s.strip.empty?
+            url = sprintf("v1/payments/sale/%s", saleid.to_s.strip)
+            response = api.get(url)
+            new(response)
+          end
+        end
+
+        def refund(refund)
+          raise ArgumentError.new("id required") if self.id.to_s.strip.empty?
+          url = sprintf("v1/payments/sale/%s/refund", self.id.to_s.strip)
+          refund = Refund.new(refund) unless refund.is_a? Refund
+          response = api.post(url, refund.to_hash, refund.http_header)
+          Refund.new(response)
+        end
+      end
+
+
+
+      class Authorization < Resource
+        def self.load_members
+          object_of :id, String
+          object_of :create_time, String
+          object_of :update_time, String
+          object_of :state, String
+          object_of :amount, Amount
+          object_of :parent_payment, String
+          array_of :links, Link
+        end
+      end
+
+
+
+      class Capture < Resource
+        def self.load_members
+          object_of :id, String
+          object_of :create_time, String
+          object_of :update_time, String
+          object_of :state, String
+          object_of :amount, Amount
+          object_of :parent_payment, String
+          object_of :authorization_id, String
+          object_of :description, String
+          array_of :links, Link
+        end
+      end
+
+
+
+      class RedirectUrls < Resource
+        def self.load_members
+          object_of :return_url, String
+          object_of :cancel_url, String
+        end
+      end
+
+
+
+      class PaymentExecution < Resource
+        def self.load_members
+          object_of :payer_id, String
+          array_of :transactions, Amount
+        end
+      end
+
+
+
+      class PaymentHistory < Resource
+        def self.load_members
+          array_of :payments, Payment
+          object_of :count, Integer
+          object_of :next_id, String
+        end
+      end
+
+
+
+
+
+      constants.each do |data_type_klass|
+        data_type_klass = const_get(data_type_klass)
+        data_type_klass.load_members if defined? data_type_klass.load_members
+      end
+
+    end
+  end
+end