wegift-ruby-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9ed8ed0dd39f8c1b812686edf99c071547e738c
+  data.tar.gz: 5c970c86606039b4e4e255be7bb7f153e3911566
+SHA512:
+  metadata.gz: 8fdbdee8879546c26f7b9c5d1ccc57910dd9671e6336d86d890dcf6b028f7e0b460e251cc50e777dc6dff303d4e1490170ed5e0b9c8beb29bd46c88076d8fe81
+  data.tar.gz: 86e22394fa22a046466c32783ec539496dccbec1ca5fea0adde914fd592588588fdce10f90bd137ba3dfdc0626205fd466cd5354c871457023edd6306f0c0c72

data/.gitignore

@@ -0,0 +1,25 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# idea/rubymine
+*.iml
+
+# rvm
+.ruby-gemset
+.ruby-version
+
+# vars for testing
+.env
+
+# gems
+wegift-ruby-client-*.gem

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.14.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 klaas.endrikat@googlemail.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 wegift-ruby-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Klaas Endrikat
+
+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,96 @@
+# WeGift Ruby Client
+
+A simple client for [WeGift.io][wegift] B2B Synchronous API (Document Version 1.2). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wegift-ruby-client'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install wegift-ruby-client
+```
+
+## Usage
+
+Simple example for ordering a Digital Card
+```ruby
+# a simple client 
+client = Wegift::Client.new(
+      :api_host => 'http://sandbox.wegift.io',
+      :api_path => '/api/b2b-sync/v1/auth'
+      :api_key => ENV['AUTH_NAME'],
+      :api_secret => ENV['AUTH_PASS']
+)
+
+# and a simple request
+order = Wegift::Order.new(
+        :product_code => 'tTV',
+        :delivery => 'direct',
+        :amount => '42.00',
+        :currency_code => 'USD',
+        :external_ref => '123'
+)
+
+# executes the POST (TODO: shared/singleton client?)
+order.post(client) 
+
+# and returns
+if order.is_successful?
+
+  # some nice data
+  order.code
+  order.pin
+  order.expiry_date
+  
+end
+```
+
+_See official docs for Product Codes (http://sandbox.wegift.io/product-codes)_
+
+## 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).
+
+### Testing
+
+Run it!
+```bash
+rspec
+```
+
+It will load all tapes found in `spec/tapes`, we are using [VCR][vcr].
+
+Optional - If you want/need to remaster all the recordings, you will need a sandbox account. 
+Add an `.env` file to your root:
+
+```bash
+# .env
+AUTH_NAME='sandbox_username'
+AUTH_PASS='sandbox_password'
+```
+
+Start the VCR with `rspec` - this should add all Tapes to `spec/tapes`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kendrikat/wegift-ruby-client. 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).
+
+[wegift]: http://WeGift.io
+[vcr]: https://github.com/vcr/vcr

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wegift/ruby/client"
+
+# 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(__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/wegift.rb

@@ -0,0 +1,5 @@
+require_relative 'wegift/models/order'
+
+module Wegift
+
+end

data/lib/wegift/client.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'faraday'
+
+module Wegift
+
+  class Client
+    attr_accessor :api_host, :api_path, :api_key, :api_secret, :connection
+
+    # supported: basic-http-auth - see: http://sandbox.wegift.io
+
+    def initialize(options = {})
+      @api_host = options[:api_host] || 'http://sandbox.wegift.io'
+      @api_path = options[:api_path] || '/api/b2b-sync/v1'
+      @api_key = options[:api_key].to_s
+      @api_secret = options[:api_secret]
+
+      @connection = Faraday.new(:url => @api_host)
+      @connection.basic_auth(@api_key, @api_secret)
+    end
+
+    # KISS since we have only one call!
+    def post(path, payload = {})
+      @connection.post do |req|
+        req.url [@api_path, path].join('')
+        req.headers['Content-Type'] = 'application/json'
+        req.body = payload.to_json
+      end
+    end
+
+    # TODO: shared context/connection for all calls
+    # keep client => https://github.com/lostisland/faraday#basic-use
+
+  end
+
+end

data/lib/wegift/models/order.rb

@@ -0,0 +1,74 @@
+require_relative 'response'
+
+class Wegift::Order < Wegift::Response
+
+  PATH = '/order-digital-card'
+
+  DELIVERY_TYPE = {:direct => 'direct', :email => 'email'}
+
+  # request/payload
+  attr_accessor :product_code, :delivery, :amount, :currency_code, :external_ref
+
+  # response/success
+  attr_accessor :code, :expiry_date, :pin
+
+  def initialize(options = {})
+    @product_code = options[:product_code]
+    @delivery = options[:delivery].eql?(DELIVERY_TYPE[:email]) ? options[:delivery] : DELIVERY_TYPE[:direct]
+    @amount = options[:amount]
+    @currency_code = options[:currency_code]
+    @external_ref = options[:external_ref]
+  end
+
+  def payload
+    {
+        :product_code => @product_code,
+        :delivery => @delivery,
+        :amount => @amount,
+        :currency_code => @currency_code,
+        :external_ref => @external_ref,
+    }
+  end
+
+  # Order Digital Card
+  # POST /api/b2b-sync/v1/order-digital-card
+  def post(ctx)
+    response = ctx.post(PATH, self.payload)
+    self.parse(JSON.parse(response.body))
+  end
+
+  def parse(data)
+    super(data)
+
+    # nested status/error object
+    # assuming root "status" is always "SUCCESS" if "e_code" is set
+    #{
+    #  "e_code": {
+    #    "error_code": "EC001",
+    #    "error_string": "Error retrieving E-Code from data processor",
+    #    "status": "ERROR"
+    #   },
+    #  "error_code": null,
+    #  "error_details": null,
+    #  "error_string": null,
+    #  "order_id": 18,
+    #  "status": "SUCCESS"
+    #}
+
+    # override root "status" if set
+    if data['e_code'] && data['e_code']['status'].eql?(STATUS[:error])
+      @status = data['e_code']['status']
+      @error_code = data['e_code']['error_code'] unless data['e_code']['error_code'].blank?
+      @error_string = data['e_code']['error_string'] unless data['e_code']['error_string'].blank?
+      @error_details = data['e_code']['error_details'] unless data['e_code']['error_details'].blank?
+    end
+
+    # set valid data
+    if data['e_code'] && data['e_code']['status'].eql?(STATUS[:success])
+      @code = data['e_code']['code']
+      @expiry_date = data['e_code']['expiry_date']
+      @pin = data['e_code']['pin']
+    end
+  end
+
+end

data/lib/wegift/models/response.rb

@@ -0,0 +1,28 @@
+class Wegift::Response
+
+  STATUS = {:success => 'SUCCESS', :error => 'ERROR'}
+
+  # Field Name Contents
+  #
+  # status        - The status of the transaction. Usually “SUCCESS” or “ERROR”
+  # error_code    - The error code, i.e. SE002
+  # error_string  - Description of the error code, i.e. Required field missing from request
+  # error_details - Details of the particular error, i.e. Field "delivery" missing from request
+
+  # global shared body
+  attr_accessor :status, :error_code, :error_string, :error_details
+
+  def is_successful?
+    @status && @status.eql?(STATUS[:success])
+  end
+
+  def parse(data = {})
+    @status = data['status']
+    @error_code = data['error_code']
+    @error_string = data['error_string']
+    @error_details = data['error_details']
+  end
+
+  # TODO
+
+end

data/lib/wegift/version.rb

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

data/wegift-ruby-client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wegift/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wegift-ruby-client'
+  spec.version       = Wegift::VERSION
+  spec.authors       = ['Klaas Endrikat']
+  spec.email         = ['klaas.endrikat@googlemail.com']
+
+  spec.summary       = %q{A simple Ruby client for the WEGIFT API}
+  spec.homepage      = 'https://github.com/kendrikat/wegift-ruby-client'
+  spec.license       = 'MIT'
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_dependency 'faraday', '~> 0.9', '>= 0.9.2'
+  spec.add_dependency 'json', '~> 1.7', '>= 1.7.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.2'
+  spec.add_development_dependency 'dotenv', '~> 2.2', '>= 2.2.0'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: wegift-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Klaas Endrikat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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.3
+  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.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: 
+email:
+- klaas.endrikat@googlemail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wegift.rb
+- lib/wegift/client.rb
+- lib/wegift/models/order.rb
+- lib/wegift/models/response.rb
+- lib/wegift/version.rb
+- wegift-ruby-client.gemspec
+homepage: https://github.com/kendrikat/wegift-ruby-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+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: A simple Ruby client for the WEGIFT API
+test_files: []