securetrading 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 267c87fa55b87574dfa58dea6a4da76083a27bd4
+  data.tar.gz: bcbf98e2f5be0cd29a71bc99e8eb87d6ae0cb994
+SHA512:
+  metadata.gz: bbd79a4d7f3700ae3da76a66027ab92dbce3a90ecb00fe12e62262fb1024f4c4af4d5b09ceffeeea4051fc292a2bcb10e33bccd32d03bf9ef920dd296c346135
+  data.tar.gz: eff794acdbf6cb1be1ec7545a97512fd73573e5863469bf40e27db9d395a59ff12caa264b580e4aa7030f6767b5bedbdf3958c7037ade6791baa5f02da85e7be

data/.codeclimate.yml

@@ -0,0 +1,13 @@
+engines:
+  rubocop:
+    enabled: true
+  fixme:
+    enabled: true
+  bundler-audit:
+    enabled: true
+ratings:
+  paths:
+  - lib/**
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.swo
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'Gemfile'
+    - 'Guardfile'
+    - 'Rakefile'
+    - 'securetrading.gemspec'
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6
+addons:
+  code_climate:
+    repo_token: dc350da1789e06c14050d5bcbeb3fa50ce3208ff55a8fc4573e8dbf9f7c637c2
+
+env:
+  - BUILDER=travis

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,27 @@
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+
+    # Turnip features and steps
+    watch(%r{^spec/acceptance/(.+)\.feature$})
+    watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+      Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+    end
+  end
+
+  guard :rubocop, all_on_start: false, cli: ['--rails', '--auto-correct'] do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+### The MIT License (MIT)
+
+Copyright (c) 2015 Bitgame Labs Inc.
+
+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,92 @@
+[![Code Climate](https://codeclimate.com/github/bitgaming/securetrading/badges/gpa.svg)](https://codeclimate.com/github/bitgaming/securetrading)
+[![Test Coverage](https://codeclimate.com/github/bitgaming/securetrading/badges/coverage.svg)](https://codeclimate.com/github/bitgaming/securetrading/coverage)
+[![Build Status](https://travis-ci.org/bitgaming/securetrading.svg)](https://travis-ci.org/bitgaming/securetrading)
+
+# Securetrading
+
+Ruby library for [securetrading](http://www.securetrading.com/) API integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'securetrading'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install securetrading
+
+## Usage
+
+### Configuration
+
+Set up configuration options in initializer like this:
+
+```
+Securetrading.configure do |c|
+  c.user = 'user_site1234@securetrading.com'
+  c.password = 'password'
+  c.site_reference = 'site1234'
+end
+```
+
+### Supported Api requests
+
+Currently supported methods:
+
+#### REFUND
+
+Parameters:
+- amount - refunded amount in cents
+- order reference - original transaction reference you want to refund. Required for Refund. Not required for CFT Refund.
+- options - Hash of options.
+  - merchant - Check XML specification for merchant xml tags.
+  - account_type - default to ECOM. If you want to set different ```accounttypedescription``` xml tag you should set this option.
+
+```ruby
+> ref = Securetrading::Refund.new(11, '1-9-1912893', { merchant: { orderreference: 'order2'}, account_type: 'CFT' })
+> ref.perform
+```
+
+Will send post request with xml:
+
+```XML
+<requestblock version="3.67">
+  <alias>user_site1234@securetrading.com</alias>
+  <request type="REFUND">
+    <operation>
+      <sitereference>site1234</sitereference>
+      <accounttypedescription>CFT</accounttypedescription>
+      <parenttransactionreference>1-9-1912893</parenttransactionreference>
+    </operation>
+    <merchant>
+      <orderreference>order2</orderreference>
+    </merchant>
+    <billing>
+      <amount>11</amount>
+    </billing>
+  </request>
+</requestblock>
+```
+
+## 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/bitgamelabs/securetrading. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'securetrading'
+
+# 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
+
+require 'irb'
+IRB.start

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/setup

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

data/lib/securetrading.rb

@@ -0,0 +1,27 @@
+require 'securetrading/version'
+require 'ox'
+require 'httparty'
+require 'active_support'
+require 'active_support/core_ext'
+require 'securetrading/configuration'
+
+module Securetrading
+  class Error < StandardError; end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  class << self
+    attr_writer :config
+  end
+  private_class_method 'config='
+end
+
+require 'securetrading/connection'
+require 'securetrading/xml_doc'
+require 'securetrading/refund'

data/lib/securetrading/configuration.rb

@@ -0,0 +1,21 @@
+module Securetrading
+  class ConfigurationError < StandardError; end
+  class Configuration
+    attr_accessor :user, :password
+    attr_writer :site_reference
+
+    def site_reference
+      return @site_reference if @site_reference.present?
+      fail ConfigurationError, 'Site reference is required!'
+    end
+
+    def auth
+      return @auth if @auth.present?
+      if user.present? && password.present?
+        @auth ||= Base64.encode64("#{user}:#{password}")
+      else
+        fail ConfigurationError, 'User and password or auth are required!'
+      end
+    end
+  end
+end

data/lib/securetrading/connection.rb

@@ -0,0 +1,26 @@
+module Securetrading
+  class Connection
+    include HTTParty
+    base_uri 'https://webservices.securetrading.net/xml'
+
+    # headers after: http://www.securetrading.com/files/documentation/STPP-Web-Services-User-Guide.pdf
+    headers(
+      'Content-Type' => 'text/xml;charset=utf-8',
+      'Accept-Encoding' => 'gzip',
+      'Accept' => 'text/xml',
+      'User-Agent' => 'Securetrading Ruby gem; '\
+                      "version: #{Securetrading::VERSION}",
+      'Connection' => 'close'
+    )
+
+    def post_with(xml, options = {})
+      self.class.post('/', options.merge(body: xml, headers: dynamic_headers))
+    end
+
+    private
+
+    def dynamic_headers
+      { 'Authorization' => "Basic #{Securetrading.config.auth}" }
+    end
+  end
+end

data/lib/securetrading/refund.rb

@@ -0,0 +1,51 @@
+module Securetrading
+  class Refund < Connection
+    def initialize(amount, parent_transaction, options = {})
+      @amount = amount
+      @parent_transaction = parent_transaction
+      @account_type = options[:account_type].presence || 'ECOM'
+      @options = options
+    end
+
+    def perform(options = {})
+      post_with(to_xml, options)
+    end
+
+    def to_xml
+      Ox.dump(ox_xml)
+    end
+
+    private
+
+    def ox_xml
+      return doc if xml_prepared?
+      req = doc.requestblock.request
+      req << merchant << billing
+      req.operation << transaction_reference
+      @xml_prepared = true
+      doc
+    end
+
+    def doc
+      @doc ||= XmlDoc.new('REFUND', @account_type).doc
+    end
+
+    def transaction_reference
+      return '' unless @parent_transaction.present?
+      XmlDoc.elements(parenttransactionreference: @parent_transaction).first
+    end
+
+    def billing
+      XmlDoc.elements(billing: { amount: @amount }).first
+    end
+
+    def merchant
+      return '' unless @options[:merchant].present?
+      XmlDoc.elements(merchant: @options[:merchant]).first
+    end
+
+    def xml_prepared?
+      @xml_prepared
+    end
+  end
+end

data/lib/securetrading/version.rb

@@ -0,0 +1,3 @@
+module Securetrading
+  VERSION = '0.1.0'
+end

data/lib/securetrading/xml_doc.rb

@@ -0,0 +1,59 @@
+module Securetrading
+  class XmlDoc
+    def initialize(request_type, account_type)
+      @account_type = account_type
+      @request_type = request_type
+    end
+
+    def doc
+      return @doc if @doc.present?
+      @doc = Ox::Document.new(version: '1.0')
+      root = new_element('requestblock')
+      root[:version] = '3.67'
+      root << alias_el << request_el
+      @doc << root
+    end
+
+    def self.elements(hash)
+      return unless hash.present?
+      hash.map do |k, v|
+        el = new_element(k.to_s)
+        if v.is_a? Hash
+          elements(v).each { |e| el << e }
+        else
+          el << v.to_s
+        end
+        el
+      end
+    end
+
+    def self.new_element(name)
+      Ox::Element.new(name)
+    end
+
+    private
+
+    def new_element(name)
+      self.class.new_element(name)
+    end
+
+    def operation
+      self.class.elements(
+        operation: {
+          sitereference: Securetrading.config.site_reference,
+          accounttypedescription: @account_type
+        }
+      ).first
+    end
+
+    def alias_el
+      self.class.elements(alias: Securetrading.config.user).first
+    end
+
+    def request_el
+      el = new_element('request')
+      el[:type] = @request_type
+      el << operation
+    end
+  end
+end

data/securetrading.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'securetrading/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'securetrading'
+  spec.version       = Securetrading::VERSION
+  spec.authors       = ['Bitgamelabs']
+  spec.email         = ['philip.chan@bitgamelabs.com']
+
+  spec.summary       = 'Ruby library for securetrading.com API integration.'
+  spec.description   = 'Ruby library for securetrading.com API integration.'
+  spec.homepage      = 'https://github.com/bitgamelabs/securetrading'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'ox'
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: securetrading
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bitgamelabs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Ruby library for securetrading.com API integration.
+email:
+- philip.chan@bitgamelabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/setup
+- lib/securetrading.rb
+- lib/securetrading/configuration.rb
+- lib/securetrading/connection.rb
+- lib/securetrading/refund.rb
+- lib/securetrading/version.rb
+- lib/securetrading/xml_doc.rb
+- securetrading.gemspec
+homepage: https://github.com/bitgamelabs/securetrading
+licenses:
+- MIT
+metadata: {}
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby library for securetrading.com API integration.
+test_files: []