swipehq 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swipehq.gemspec
+gemspec
+
+gem 'rb-fsevent'

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marcelo Wiermann
+
+MIT License
+
+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,29 @@
+# Swipehq::Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'swipehq'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swipehq
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/simple.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../../lib/swipehq', __FILE__)
+
+puts "=== Starting SwipeHQ API test"
+SwipeHQ.configure do |config|
+  config.api_key = ENV['SWIPEHQ_API_KEY']
+  config.merchant_id = ENV['SWIPEHQ_MERCHANT_ID']
+  config.callback_url = ENV['SWIPEHQ_CALLBACK_URL']
+end
+
+puts "=== Setting up Callback URL"
+SwipeHQ.set_callback_url
+
+puts "=== Creating Transaction"
+params = {
+  item: 'Item',
+  description: 'Description for Item',
+  amount: 100.00,
+  default_quantity: 1,
+  user_data: 'Data for user',
+  currency: 'NZD'
+}
+@transaction = SwipeHQ::Transaction.new(params)
+@transaction.create
+msg = <<-EOF
+
+  Transaction Identifier: #{@transaction.identifier}
+  Transaction ID: #{@transaction.id}
+  Payment URL: #{@transaction.payment_url}
+
+  EOF
+
+puts msg
+
+puts "=== Complete Transaction on browser and press enter to proceed"
+proceed = gets
+if !proceed.empty?
+  puts "=== Verifying Transaction Status"
+  @transaction.verify
+  puts msg
+end

data/lib/swipehq.rb

@@ -0,0 +1,58 @@
+require 'bundler/setup'
+require 'rest_client'
+require 'json'
+
+require "swipehq/version"
+require "swipehq/transaction"
+
+module SwipeHQ
+  extend self
+
+  LIB_PATH = File.dirname(__FILE__) + '/swipehq/'
+
+  def configure
+    yield self
+  end
+
+  %w{ api_key merchant_id callback_url lpn_url }.each do |setting|
+    define_method "#{setting}" do
+      instance_variable_get("@#{setting}") || instance_variable_set("@#{setting}", nil)
+    end
+
+    define_method "#{setting}=" do |value|
+      instance_variable_set("@#{setting}", value)
+    end
+  end
+
+  def request(method = :get, url, params)
+    raw_response = RestClient.send(method, url, params: params)
+    if raw_response
+      JSON.parse(raw_response)
+    else
+      nil
+    end
+  end
+
+  def set_callback_url
+    return nil unless callback_url
+    params = {
+      api_key: SwipeHQ.api_key,
+      merchant_id: SwipeHQ.merchant_id,
+      callback_url: callback_url
+    }
+    url = 'https://api.swipehq.com/setCallback.php'
+    request(:post, url, params: params)
+  end
+
+  def set_lpn_url
+    return nil unless lpn_url
+    params = {
+      api_key: SwipeHQ.api_key,
+      merchant_id: SwipeHQ.merchant_id,
+      lpn_url: lpn_url
+    }
+    url = 'https://api.swipehq.com/setCallback.php'
+    request(:post, url, params: params)
+  end
+
+end

data/lib/swipehq/transaction.rb

@@ -0,0 +1,72 @@
+module SwipeHQ
+  class Transaction
+
+    attr_accessor :identifier, :item, :description, :amount, :default_quantity, :user_data, :currency,
+                  :status
+
+    attr_reader :id, :status, :approved
+
+    def initialize(params = nil)
+      if params
+        params.each do |k,v|
+          self.send("#{k}=",v)
+        end
+      end
+    end
+
+    def attributes
+      a = {}
+      %w{ identifier id item description amount default_quantity user_data currency }.each do |att|
+        a[att.to_sym] = self.send(att)
+      end
+      return a
+    end
+
+    def create
+      params = {
+        api_key: SwipeHQ.api_key,
+        merchant_id: SwipeHQ.merchant_id
+      }
+      attributes.each do |k,v|
+        params["td_#{k}".to_sym] = v
+      end
+      res = SwipeHQ.request(
+        :get,
+        'https://api.swipehq.com/createTransactionIdentifier.php',
+        params
+      )
+      if res['response_code'] and res['response_code'] == 200
+        @identifier = res['data']['identifier']
+      else
+        @identifier = nil
+      end
+    end
+
+    def verify
+      return nil unless @identifier
+      params = {
+        api_key: SwipeHQ.api_key,
+        merchant_id: SwipeHQ.merchant_id,
+        transaction_id: @identifier
+      }
+      res = SwipeHQ.request(
+        :get,
+        'https://api.swipehq.com/verifyTransaction.php',
+        params
+      )
+      if res['response_code'] and res['response_code'] == 200
+        @id = res['data']['transaction_id']
+        @status = res['data']['status'] || 'pending'
+        @approved = res['data']['transaction_approved'] == 'yes'
+      else
+        @status = nil
+      end
+    end
+
+    def payment_url
+      return nil unless @identifier
+      "https://payment.swipehq.com/?identifier_id=#{@identifier}"
+    end
+
+  end
+end

data/lib/swipehq/version.rb

@@ -0,0 +1,3 @@
+module SwipeHQ
+  VERSION = "0.0.2"
+end

data/spec/factories/transactions.rb

@@ -0,0 +1,12 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+  factory :transaction, class: SwipeHQ::Transaction do
+    sequence(:item){ |n| "Item #{n}" }
+    sequence(:description){ |n| "Description for Item #{n}" }
+    amount{ 100 }
+    default_quantity{ 1 }
+    user_data { { a: 1, b: 2, c: 3 }.to_json }
+    currency{ 'NZD' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../../lib/swipehq', __FILE__)
+require 'rspec'
+require 'mocha/setup'
+require 'factory_girl'
+
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/transaction_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe SwipeHQ::Transaction do
+
+  let(:successful_create_request){ SwipeHQ.stub(:request) }
+
+  describe '#initialize' do
+    context 'sets parameters correctly' do
+      let(:params){
+        {
+          item: 'Item',
+          description: 'Description for Item',
+          amount: 100.00,
+          default_quantity: 1,
+          user_data: 'Data for user',
+          currency: 'NZD'
+        }
+      }
+      let(:transaction){ SwipeHQ::Transaction.new(params) }
+
+      it { transaction.attributes =~ params }
+    end
+  end
+
+  describe '#create' do
+
+    let(:transaction){ FactoryGirl.build(:transaction) }
+
+    context 'valid params' do
+      let(:response){ { 'response_code' => 200, 'message' => 'OK', 'data' => {'identifier' => 'XXXX'} } }
+
+      before(:each) do
+        SwipeHQ.stubs(:request).returns(response)
+        transaction.create
+      end
+
+      it{ transaction.identifier.should eq response['data']['identifier'] }
+    end
+
+  end
+
+  describe '#verify' do
+
+    let(:transaction){ FactoryGirl.build(:transaction, identifier: 'XXXX') }
+
+    context 'pending' do
+      let(:response){ { 'response_code' => 200, 'message' => 'OK', 'data' => { 'transaction_id' => 'YYYY', 'status' => nil, 'transaction_approved' => 'no' } } }
+
+      before(:each) do
+        SwipeHQ.stubs(:request).returns(response)
+        transaction.verify
+      end
+
+      it { transaction.id.should eq(response['data']['transaction_id']) }
+      it { transaction.status.should eq('pending') }
+      it { transaction.approved.should eq(false) }
+    end
+
+    context 'approved' do
+      let(:response){ { 'response_code' => 200, 'message' => 'OK', 'data' => { 'transaction_id' => nil, 'status' => 'approved', 'transaction_approved' => 'yes' } } }
+
+      before(:each) do
+        SwipeHQ.stubs(:request).returns(response)
+        transaction.verify
+      end
+
+      it { transaction.id.should eq(nil) }
+      it { transaction.status.should eq('approved') }
+      it { transaction.approved.should eq(true) }
+    end
+
+    context 'declined' do
+      let(:response){ { 'response_code' => 200, 'message' => 'OK', 'data' => { 'transaction_id' => 'YYYY', 'status' => 'declined', 'transaction_approved' => 'no' } } }
+
+      before(:each) do
+        SwipeHQ.stubs(:request).returns(response)
+        transaction.verify
+      end
+
+      it { transaction.id.should eq(response['data']['transaction_id']) }
+      it { transaction.status.should eq('declined') }
+      it { transaction.approved.should eq(false) }
+    end
+
+  end
+
+  describe '#payment_url' do
+
+    context 'with transaction identifier' do
+      let(:identifier) { 'XXXX' }
+      let(:transaction) { FactoryGirl.build(:transaction, identifier: identifier) }
+
+      it { transaction.payment_url.should eq("https://payment.swipehq.com/?identifier_id=#{identifier}") }
+    end
+
+    context 'without transaction identifier' do
+      let(:identifier) { nil }
+      let(:transaction) { FactoryGirl.build(:transaction, identifier: identifier) }
+
+      it { transaction.payment_url.should eq(nil) }
+    end
+
+  end
+
+end

data/swipehq.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swipehq/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "swipehq"
+  gem.version       = SwipeHQ::VERSION
+  gem.authors       = ["Marcelo Wiermann"]
+  gem.email         = ["marcelo.wiermann@gmail.com"]
+  gem.description   = %q{SwipeHQ for Ruby}
+  gem.summary       = %q{SwipeHQ for Ruby}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rest-client'
+  gem.add_dependency 'json'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'factory_girl'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'shoulda'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: swipehq
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Marcelo Wiermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SwipeHQ for Ruby
+email:
+- marcelo.wiermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/simple.rb
+- lib/swipehq.rb
+- lib/swipehq/transaction.rb
+- lib/swipehq/version.rb
+- spec/factories/transactions.rb
+- spec/spec_helper.rb
+- spec/transaction_spec.rb
+- swipehq.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: SwipeHQ for Ruby
+test_files:
+- spec/factories/transactions.rb
+- spec/spec_helper.rb
+- spec/transaction_spec.rb