enviso 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 868fa4f07cd6d42b1a22917a7e45982f0e569c31ef96f497e6239a9982270429
+  data.tar.gz: 14ce3150ee9ce8b0d0c5b6fa7d500bb2e5e1e5b33d81a9920de7270c0ae1fe59
+SHA512:
+  metadata.gz: ba681cca43b4abab40b191118e9b105d0517c83bd843255f525cd18b9b37c5be05ebc41f0762c5ede5680ed2c3eeb9002edde46bdc13ac46130d770b687296bb
+  data.tar.gz: 491c5d20966bbcf2fda9b90905dbb98e1073bc609f345e6dc8b7636255c81b12925f61fcfa4553166872dda258c48da2ea010be6027f0d09dbc9e2c5cac60720

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

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 meijerhenk@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in Enviso.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    enviso (0.1.2)
+      openssl
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    netrc (0.11.0)
+    openssl (2.1.2)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  enviso!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Henk Meijer
+
+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,61 @@
+# Enviso
+
+This gem works as a simple Ruby wrapper for the Enviso API. The Enviso API has a very straight forward REST API. 
+
+All this gem does, is make it a little bit simpler to use the API:
+- You can set your credentials via Rails config
+- Authrization keys are renewed/requested automatically
+- You can make REST requests right away, without having to worry about authentication
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enviso'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enviso
+
+## Configuration
+
+First, obtain an API key and shared secret from Enviso. Set it up like this:
+```ruby
+Enviso::Config.api_key      = "MY-API-KEY"
+Enviso::Config.api_secret   = "MY-API-SHARED-SECRET" # pubic key
+Enviso::Config.tenant_key   = "TENANT-KEY"
+Enviso::Config.verbose      = false # set 'true' to show raw API input/output
+Enviso::Config.api_link     = "https://api.staging-enviso.io/resellingapi/"
+Enviso::Config.api_version  = 1 
+```
+
+To use this gem in a Rails project:
+```ruby
+# config/development.rb
+config.enviso.api_key      = "MY-API-KEY"
+config.enviso.api_secret   = "MY-API-SHARED-SECRET" # pubic key
+config.enviso.tenant_key   = "TENANT-KEY"
+config.enviso.verbose      = false # set 'true' to show raw API input/output
+config.enviso.api_link     = "https://api.staging-enviso.io/resellingapi/"
+config.enviso.api_version  = 1 
+```
+
+## Usage
+
+All there is left is to use the API according to the documentation:
+
+```ruby
+Enviso::API.send_request(type: :get, endpoint: "venues/84/offers")
+# => Returns Hash from JSON response
+```
+
+## Code of Conduct
+
+Everyone interacting in the Enviso project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/Enviso/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 "Enviso"
+
+# 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/enviso.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "enviso/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "enviso"
+  spec.version       = Enviso::VERSION
+  spec.authors       = ["Henk Meijer"]
+  spec.email         = ["hmeijer@eskesmedia.nl"]
+
+  spec.summary       = %q{Ruby wrapper for the Enviso API}
+  spec.description   = %q{Ruby wrapper for the Enviso API}
+  spec.homepage      = "https://bitbucket.org/eskes_media/enviso"
+  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://bitbucket.org/eskes_media/enviso"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://bitbucket.org/eskes_media/enviso"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "rest-client"
+  # spec.add_dependency "digest"
+  spec.add_dependency "openssl"
+    
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/enviso.rb

@@ -0,0 +1,22 @@
+module Enviso
+end
+
+require "enviso/config"
+require "enviso/engine" if defined?(Rails) && Rails::VERSION::MAJOR.to_i >= 3
+require "enviso/api"
+require "enviso/authentication"
+
+module Enviso
+  class Error < StandardError; end
+
+  # For testing purpose only: set the username and password
+  # in environment variables to make the tests pass with your test
+  # credentials.
+  def self.set_credentials_from_environment
+    Config.api_key 		= ENV["ENVISO_API_KEY"]
+    Config.api_secret = ENV["ENVISO_API_SECRET"]
+		Config.tenant_key = ENV["ENVISO_TENANT_KEY"]
+  end
+
+
+end

data/lib/enviso/api.rb

@@ -0,0 +1,86 @@
+module Enviso::API
+
+
+  # The communication layer implements all the methods available in the Enviso API
+  class << self
+
+    require 'rest-client'  	
+    require 'json'
+
+    # Sends a request to the Enviso API and returns the parsed results
+    
+    def send_request(type: :get, endpoint: String, body: nil, token: nil)
+      url = "#{Enviso::Config.api_link}v#{Enviso::Config.api_version}/#{endpoint}"
+      begin
+        
+        if token.nil?
+          unless endpoint.include?("apis")
+            Enviso::Authentication.get_new_token
+          end
+        end
+
+        if Enviso::Config.verbose
+          puts "[ENVISO] Sending #{type.upcase} request to #{url}"
+          puts "[ENVISO] Body:\n#{body}" if body
+        end
+        
+        if type.to_sym == :post
+          begin
+            result = RestClient.post url, body.to_json, headers
+          rescue RestClient::Unauthorized, RestClient::Forbidden => err
+            raise "Access denied. API Response:\n#{err.response}"
+          end
+        elsif type.to_sym == :put
+          begin
+            result = RestClient.put url, body.to_json, headers
+          rescue RestClient::Unauthorized, RestClient::Forbidden => err
+            raise "Access denied. API Response:\n#{err.response}"
+          end
+        elsif type.to_sym == :delete
+          begin
+            # result = RestClient.delete url, headers
+            result = RestClient::Request.execute(
+              method: :delete, 
+              url: url,
+              body: body,
+              headers: headers)
+          rescue RestClient::Unauthorized, RestClient::Forbidden => err
+            raise "Access denied. API Response:\n#{err.response}"
+          end
+        elsif type.to_sym == :get
+          begin
+            result = RestClient.get url, headers
+          rescue RestClient::Unauthorized, RestClient::Forbidden => err
+            raise "Access denied. API Response:\n#{err.response}"
+          end
+        end
+
+        puts "[ENVISO] Result:\n#{result}" if Enviso::Config.verbose
+        begin
+          return JSON.parse(result)
+        rescue
+          return result
+        end
+      rescue RestClient::BadRequest => err
+        raise "Bad Request. API Response:\n#{err.response}"
+      end
+    end
+
+    # HTTP headers to send in each request
+
+    def headers
+     h = {
+        content_type: :json, 
+        accept: :json, 
+        cache_control: 'no-cache', 
+        'x-api-key' => Enviso::Config.api_key, 
+        'x-tenantsecretkey' => Enviso::Config.tenant_key
+      }
+      if Enviso::Authentication.auth_token
+        h["Authorization"] = "bearer #{Enviso::Authentication.auth_token}"
+      end
+      return h
+    end
+
+  end
+end

data/lib/enviso/authentication.rb

@@ -0,0 +1,93 @@
+module Enviso::Authentication
+	require 'digest'
+  require 'base64'
+  require 'openssl'
+
+  # The communication layer implements all the methods available in the Enviso API
+  class << self
+    attr_accessor :auth_token
+    attr_accessor :refresh_token
+
+    # Set's the default value's to nil and false
+    # @return [Hash] configuration options
+    def init!
+      @defaults = {
+        :@auth_token    => nil,
+        :@refresh_token => nil
+      }
+    end
+
+  	
+    # in the authentication documentation, chapter 4.1:
+    # 1.  Concatenate the API key with the current timestamp in the format below:
+    #     <<APIKEY>>_<<timestamp(yyyy'-'MM'-'ddTHH:mm:ss.fffZ)>>
+    # NOTE: The timestamp is in ISO 8601 
+    def timestamp_for_authentication
+      return Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ')
+    end
+  	
+    # The method calculates the login signature, as described
+		# 2.  Create a SHA256 hash of this value. Based on the hashed value, a digital signature will be created.
+
+  	def calculate_login_signature(timestamp)
+  		api_key = Enviso::Config.api_key
+  		return Digest::SHA256.hexdigest("#{api_key}_#{timestamp}")
+      # return OpenSSL::Digest::SHA256.new("#{api_key}_#{timestamp}")
+  	end
+
+
+    # Signs the login signature hash
+		# From the authentication documentation, chapter 4.1:
+		# 3. The combination of the created signature along with the provided API secret key will act as the digital signature of the call.
+
+  	def sign_login_signature(key)
+      secret = Enviso::Config.api_secret
+      public_key = OpenSSL::PKey::RSA.new(secret)
+      encrypted_string = Base64.encode64(public_key.public_encrypt(key))
+      return encrypted_string
+  	end
+
+    # This method combines all the login steps
+    # 1. generate a key (SHA256)
+    # 2. signs the key with public_key
+    # 3. sends request to API endpoint
+
+    def login(signed_key: nil)
+      self.auth_token  = nil # reset to prevent giving auth token in login request headers
+      
+      timestamp   = timestamp_for_authentication
+      key         = calculate_login_signature(timestamp)
+      signed_key  = sign_login_signature(key) unless signed_key
+
+      body = {
+        apikey: Enviso::Config.api_key,
+        timestamp: timestamp,
+        signature: signed_key
+      }
+      result = Enviso::API.send_request(type: :post, endpoint: "apis/login", body: body)
+      if result["authToken"]
+        self.refresh_token = result["refreshToken"]
+        self.auth_token = result["authToken"]
+      end
+      return result
+    end
+
+    # Get new access token using refresh token from login request response
+    def get_new_token
+      body = { refreshToken: refresh_token }
+      puts "Refreshing token" if Enviso::Config.verbose
+      begin
+        result = Enviso::API.send_request(type: :post, endpoint: "apis/getnewtoken", body: body)
+        if result["token"]
+          self.auth_token = result["token"]
+        end
+        return result
+      rescue
+        puts "Signing in again to refresh token" if Enviso::Config.verbose
+        login
+      end
+    end
+
+  end
+  init!
+end

data/lib/enviso/config.rb

@@ -0,0 +1,48 @@
+#
+# Configuration object for storing some parameters required for making transactions
+#
+
+module ::Enviso::Config
+  class << self
+    attr_accessor :api_key
+    attr_accessor :api_secret
+    attr_accessor :tenant_key
+    attr_accessor :verbose
+    attr_accessor :api_link
+    attr_accessor :api_version
+    attr_accessor :environment
+    
+
+
+    # Set's the default value's to nil and false
+    # @return [Hash] configuration options
+    def init!
+      @defaults = {
+        :@api_key       => nil,
+        :@api_secret    => nil,
+        :@tenant_key    => nil,
+        :@verbose       => false,
+        :@environment   => :test,
+        :@api_version   => 1,
+        :@api_link      => "https://api.staging-enviso.io/resellingapi/"
+      }
+    end
+
+    # Resets the value's to there previous value (instance_variable)
+    # @return [Hash] configuration options
+    def reset!
+      @defaults.each { |key, value| instance_variable_set(key, value) }
+    end
+
+    # Set's the new value's as instance variables
+    # @return [Hash] configuration options
+    def update!
+      @defaults.each do |key, value|
+        instance_variable_set(key, value) unless instance_variable_defined?(key)
+      end
+    end
+  end
+  init!
+  reset!
+
+end

data/lib/enviso/engine.rb

@@ -0,0 +1,15 @@
+module Enviso
+  #
+  # Simpel extend on the +Rails::Engine+ to add support for a new config section within
+  # the environment configs
+  #
+  # @example default
+  #   # /config/environments/development.rb
+  #   config.enviso.api_key  = "12343465sdfgsadr324"
+  #
+  
+  class Engine < ::Rails::Engine
+    isolate_namespace Enviso
+    config.enviso = Enviso::Config
+  end
+end

data/lib/enviso/version.rb

@@ -0,0 +1,3 @@
+module Enviso
+  VERSION = "0.1.5"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: enviso
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Henk Meijer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: openssl
+  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: 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'
+description: Ruby wrapper for the Enviso API
+email:
+- hmeijer@eskesmedia.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enviso.gemspec
+- lib/enviso.rb
+- lib/enviso/api.rb
+- lib/enviso/authentication.rb
+- lib/enviso/config.rb
+- lib/enviso/engine.rb
+- lib/enviso/version.rb
+homepage: https://bitbucket.org/eskes_media/enviso
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/eskes_media/enviso
+  source_code_uri: https://bitbucket.org/eskes_media/enviso
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Enviso API
+test_files: []