windcave_rest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4336597a4375374617ba683fa59bac3ec9e207c1df39fa1074a5a41dc619b964
+  data.tar.gz: b3e2048a406818e910cfb0c545737567efa8eb19c3c9f7bb025ae6a815f39b4e
+SHA512:
+  metadata.gz: b6bd7d8e04cf23d693317a5a4f4c07bfa1da9846afab33d18474d41a70e280654dc83fbc3ab46126c5838746699506e05e3be35e8d5ab13644618fe04599a611
+  data.tar.gz: 9777d346f0ec424ca8795d4e8fd151b04a4d03d1262825632d687e4305ab61abfe7d9e0d81e9c71fdf792774a40c72e2bfc79b81e9f6927106211f89f7aecf79

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

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 antodoms@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in windcave_rest.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    windcave_rest (0.1.0)
+      json
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.12.2)
+    json (2.3.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  windcave_rest!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Anto Dominic
+
+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,98 @@
+# Windcave / Payment Express REST API
+Windcave Rest API is a simple rest based API allowing merchants full integration to all payment express / windcave cloud based services.
+
+Current implementation of the gem includes the following features:
+
+* [Session Create API](https://px5.docs.apiary.io/#reference/0/sessions/create-session)
+* [Session Get API](https://px5.docs.apiary.io/#reference/0/sessions/query-session)
+* [Transaction Create API](https://px5.docs.apiary.io/#reference/0/transactions/create-transaction)
+
+Current implementation only allows interacting with these endpoints and parsing data to ruby formats correctly but it doesnt cater for different validations on certain object types.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'windcave_rest'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install windcave_rest
+
+## Usage
+
+### Session Create API
+You may create a new session using this request.
+
+```ruby
+@api_instance = WindcaveRest::SessionsApi.new
+
+@create_session_options = { 
+  body: WindcaveRest::CreateSessionRequest.new(
+    type: "purchase",
+    amount: "5.05",
+    currency: "AUD",
+    merchant_reference: "ORDER_1",
+    methods: ["card"],
+    store_card: true, # optional
+    stored_card_indicator: "single", # optional
+  )
+}
+
+@response = @api_instance.sessions_create(@create_session_options)
+```
+
+### Session GET API
+You can use this request to query any existing session for the transaction outcome.
+
+```ruby
+@session_id = "ID of the session from previous step"
+@api_instance = WindcaveRest::SessionsApi.new
+@response = @api_instance.sessions_get(@session_id)
+
+```
+
+### Transaction create API
+Transactions are records of processed standard financial requests including; purchase, refund, auth, complete, validate and void.
+
+```ruby
+@api_instance = WindcaveRest::TransactionsApi.new
+
+@card_id = "Tokenised card ID that you can get from session GET API"
+
+@create_transaction_options = {
+    type: "purchase",
+    amount: "5.0.5",
+    currency: get_currency,
+    merchant_reference: "ORDER_1",
+    card_id: @card_id
+}
+
+@response = @api_instance.transactions_create(@create_transaction_options)
+```
+
+
+## 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/reinteractive/windcave_rest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/windcave_rest/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WindcaveRest project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/windcave_rest/blob/master/CODE_OF_CONDUCT.md).

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 "windcave_rest"
+
+# 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/windcave_rest.rb

@@ -0,0 +1,35 @@
+require "windcave_rest/version"
+require "windcave_rest/configuration"
+require 'windcave_rest/api_client'
+require 'windcave_rest/api_error'
+
+# Models
+require 'windcave_rest/models/base'
+require 'windcave_rest/models/address'
+require 'windcave_rest/models/avs'
+require 'windcave_rest/models/browser'
+require 'windcave_rest/models/callback_urls'
+require 'windcave_rest/models/card'
+require 'windcave_rest/models/create_session_request'
+require 'windcave_rest/models/create_transaction_request'
+require 'windcave_rest/models/customer'
+require 'windcave_rest/models/link'
+require 'windcave_rest/models/session'
+require 'windcave_rest/models/transaction'
+
+# Apis
+require 'windcave_rest/api/base_api'
+require 'windcave_rest/api/sessions_api'
+require 'windcave_rest/api/transactions_api'
+
+module WindcaveRest
+  class  << self
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuation.default
+      end
+    end
+  end
+end

data/lib/windcave_rest/api/base_api.rb

@@ -0,0 +1,9 @@
+module WindcaveRest
+  class BaseApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+  end
+end

data/lib/windcave_rest/api/sessions_api.rb

@@ -0,0 +1,107 @@
+module WindcaveRest
+  class SessionsApi < WindcaveRest::BaseApi
+    # Create a Session
+    # Creates a Windcave Session.  During the Session process a customer can apply for credit decisioning in real-time. This means the Session needs to represent a good picture of known customer details along with order information and the Session entity represents this as a resource.  For more information on how to Session with Windcave see the https://px5.docs.apiary.io/#reference/0/transactions/create-session guide.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateSessionRequest] :body 
+    # @return [Session]
+    def sessions_create(opts = {})
+      data, _status_code, _headers = sessions_create_with_http_info(opts)
+      return data
+    end
+
+    # Create a session
+    # Creates a Windcave Session.  During the Session process a customer can apply for credit decisioning in real-time. This means the Session needs to represent a good picture of known customer details along with order information and the Session entity represents this as a resource.  For more information on how to Session with Windcave see the #model:Z2QcrzRGHACY8wM6G guide.
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateSessionRequest] :body 
+    # @return [Array<(Session, Fixnum, Hash)>] Session data, response status code and response headers
+    def sessions_create_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SessionsApi.sessions_create ..."
+      end
+      # resource path
+      local_var_path = "/sessions"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      auth_names = ['Authorization']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Session')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SessionsApi#sessions_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve a Session
+    # Retrieves a previously created Session by id.
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [Session]
+    def sessions_get(id, opts = {})
+      data, _status_code, _headers = sessions_get_with_http_info(id, opts)
+      return data
+    end
+
+    # Retrieve a Session
+    # Retrieves a previously created Session by id.
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Session, Fixnum, Hash)>] Session data, response status code and response headers
+    def sessions_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: sessionsApi.sessions_get ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling sessionsApi.sessions_get" if id.nil?
+      # resource path
+      local_var_path = "/sessions/#{id}"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Authorization']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Session')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: sessionsApi#sessions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end