yp-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3230dd4507fd504e8bbf51ffcd53349097f6de2
+  data.tar.gz: c7a233fdb6fa2ff83823ba953b7f4217a6e442cd
+SHA512:
+  metadata.gz: f277b93d229d3d6f255e13096e03cc92c419356e1d35a53d3ce7643709adcd29ad302b7dc8fff1222ff10b238e77d20937457ceaeaed686a34eecf8bf022ced0
+  data.tar.gz: 9e1b0ca4a88bbab81292e169d23e69548e57a8fff167ac886f279b15d5520f41ac1410a4b6efe3f3617d1e08755fcdcc7c75f7ea84e5e0e794c91d13f05d44e7

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andyhall1138@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yp-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrew Hall
+
+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,39 @@
+# Yp::Ruby
+
+Ruby Class bindings for the Yorkshire Payments Direct HTTP Integration API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yp-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yp-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yp-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yp"
+
+# 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
+
+KEY = 'Engine0Milk12Next'
+
+TRANSACTION = {
+    merchantID: '101381',
+    action: 'SALE',
+    type: 1,
+    countryCode: 826,
+    currencyCode:  826,
+    amount:  1001,
+    cardNumber:  '4012001037141112',
+    cardExpiryMonth:  12,
+    cardExpiryYear:  15,
+    cardCVV:  '083',
+    customerName:  'Yorkshire Payments',
+    customerEmail:  'support@yorkshirepayments.com',
+    customerAddress:  '16 Test Street',
+    customerPostCode:  'TE15 5ST',
+    orderRef:  'Test purchase'
+}
+
+require "irb"
+IRB.start

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/exe/yp-ruby

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "yp/ruby"

data/lib/base.rb

@@ -0,0 +1,71 @@
+module Yp
+  class Base
+
+    attr_reader :params
+
+    def initialize(signature_key, **params)
+      @params = params.merge default_params
+      @signature_key = signature_key
+    end
+
+    def body
+      @params.clone.tap { |params|  params[:signature] = create_signing_hash }
+    end
+
+    def create_signing_hash
+      self.class.digest(self.class.serialize_params(@params) + @signature_key)
+    end
+
+    def send
+      if block_given?
+        RestClient.post(URL, body) do |response|
+          yield(self.class.parse response)
+        end
+      else
+        self.class.parse(RestClient.post(URL, body))
+      end
+    end
+
+    protected
+
+    def default_params
+      {}
+    end
+
+    class << self
+
+      def digest(str_params)
+        Digest::SHA512.hexdigest str_params
+      end
+
+      def serialize_params(params)
+        uri_string_from_hash(params)
+      end
+
+      def parse(response)
+        ruby_hash_from_response(CGI::parse(response))
+      end
+
+      private
+
+      def uri_string_from_hash(hash)
+        hash.map { |key, value| uri_query_param(key, value) }.sort.join '&'
+      end
+
+      def uri_query_param(key, value)
+        encode_url_component(key) + '=' + encode_url_component(value)
+      end
+
+      def encode_url_component(key)
+        ERB::Util::url_encode(key).gsub(/%20/, '+')
+      end
+
+      def ruby_hash_from_response(hash)
+        hash.reduce({}) do |memo, (key, value)|
+          memo.merge({key.to_sym => value.first})
+        end
+      end
+
+    end
+  end
+end

data/lib/factory.rb

@@ -0,0 +1,22 @@
+module Yp
+  class Factory
+
+    def initialize(merchant_id:, password: nil, signature_key:)
+      @defaults = default_params(merchant_id, password)
+      @signature_key = signature_key
+    end
+
+    def sale(params)
+      Sale.new(@signature_key,  @defaults.merge(params))
+    end
+
+    private
+
+    def default_params(id, pwd)
+      { merchantID: id }.tap do |hash|
+        hash[:merchantPwd] = pwd unless pwd.nil?
+      end
+    end
+
+  end
+end

data/lib/sale.rb

@@ -0,0 +1,11 @@
+module Yp
+  class Sale < Base
+
+    protected
+
+    def default_params
+      { action: 'SALE' }
+    end
+
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Yp
+    VERSION = "0.1.0"
+end

data/lib/yp.rb

@@ -0,0 +1,13 @@
+require 'version'
+require 'rest-client'
+require 'digest'
+require 'erb'
+require 'cgi'
+require 'base'
+
+require 'sale'
+require 'factory'
+
+module Yp
+  URL = 'https://gateway.yorkshirepayments.com/direct/'
+end

data/yp-ruby.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yp-ruby"
+  spec.version       = Yp::VERSION
+  spec.authors       = ["Andrew Hall"]
+  spec.email         = ["andrew@rioja.io"]
+
+  spec.summary       = %q{Ruby Class bindings for the Yorkshire Payments Direct HTTP Integration API}
+  spec.description   = %q{Ruby Class bindings for the Yorkshire Payments Direct HTTP Integration API}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0", ">= 3.0.1"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "rspec-given", "~> 3.8"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: yp-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Hall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Ruby Class bindings for the Yorkshire Payments Direct HTTP Integration
+  API
+email:
+- andrew@rioja.io
+executables:
+- yp-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/yp-ruby
+- lib/base.rb
+- lib/factory.rb
+- lib/sale.rb
+- lib/version.rb
+- lib/yp.rb
+- yp-ruby.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby Class bindings for the Yorkshire Payments Direct HTTP Integration API
+test_files: []