leisureking 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a84672304ff7a742ee55a6b41583033850ae46a
+  data.tar.gz: 787ea92a3cfec080bc615e23941b80b11fb2d59a
+SHA512:
+  metadata.gz: f7a45bf92772d70a4f339b0e1045f523cd33454cf100602e981f251c8a868098820c2d69bc68447ae17b29a63b8aa89323f0986d724cc76580738199d93eb7fc
+  data.tar.gz: 2f7808cafed3ab98fe3a39b49bedab94037d251c8ece77a1d812388bbd9f31176c016a3d4a3dc0f8fdf858fd3e017ecbf35db89d7a193cb153276bd5f7d2b7a5

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.6.3
+before_install: gem install bundler -v 2.0.2

data/COMMENTS.md

@@ -0,0 +1,6 @@
+# Comments for API Documentation team
+
+## Endpoint
+
+### https://api.leisureking.eu/v1l/assortiment/get
+- {"status":"ERROR","data":{"errormessage":"Ongeldige id_vestiging meegestuurd"}}

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    leisureking (0.1.0)
+      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)
+    rake (10.5.0)
+    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
+  bundler (~> 2.0)
+  leisureking!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,67 @@
+# Leisureking
+
+
+This gem works as a simple Ruby wrapper for the Leisureking API. The Leisureking 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
+
+
+Original documentation is here: https://survey.leisureking.eu/v1l/docs/authentication
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'leisureking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leisureking
+
+## Configuration
+
+First, obtain an API key and shared secret from LeisureKing. Set it up like this:
+```ruby
+LeisureKing::Config.api_key      = "MY-API-KEY"
+LeisureKing::Config.api_secret   = "MY-API-SHARED-SECRET"
+```
+
+To use this gem in a Rails project:
+```ruby
+# config/development.rb
+config.leisure_king.api_key     = "MY-API-KEY"
+config.leisure_king.api_secret  = "MY-API-SECRET"
+
+```
+
+## Usage
+
+All there is left is to use the API according to the documentation:
+
+```ruby
+LeisureKing::API.send_request("assortiment/getassortimentdatabyassortimentid", {id_assortiment: 5625})
+# => Returns Hash from JSON response
+```
+
+## 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/henkm/leisureking.
+
+## License
+
+The gem is made with ❤️ by the smart people from Eskes Media. This gem is available as open source under the terms of the [MIT License](https://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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "leisureking"
+
+# 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/leisureking.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "leisureking/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "leisureking"
+  spec.version       = LeisureKing::VERSION
+  spec.authors       = ["Henk Meijer"]
+  spec.email         = ["hmeijer@eskesmedia.nl"]
+
+  spec.summary       = %q{Ruby wrapper for the Leisureking API}
+  spec.description   = %q{Ruby wrapper for the Leisureking API}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/leisureking/api.rb

@@ -0,0 +1,74 @@
+module LeisureKing::API
+
+  # The communication layer implements all the methods available in the LeisureKing API
+  class << self
+
+    require 'rest-client'  	
+    require 'json'
+
+    # Sends a request to the LeisureKing API and returns the parsed results
+    
+    def base_uri
+      "https://api.leisureking.eu/v#{LeisureKing::Config.api_version}"
+    end
+
+    def send_request(endpoint, body = {})
+      url = "#{base_uri}/#{endpoint}"
+      body[:environment] = LeisureKing::Config.environment
+      begin
+        unless endpoint == "authenticate"
+          LeisureKing::Authentication.get_token
+        end
+        if LeisureKing::Config.verbose
+          puts "Sending request to #{url}"
+          puts "Body:\n#{body}" if body
+        end
+
+        begin
+          result = RestClient.post(url, body.to_json, headers) do |response, request, res, &block|
+            if [301, 302, 307].include? response.code
+              redirected_url = response.headers[:location]
+              if LeisureKing::Config.verbose
+                puts "Redirecting request to #{redirected_url}"
+                puts "Body:\n#{body}" if body
+              end
+              RestClient.post(redirected_url, body.to_json, headers)
+            else
+              response.return!(request, res, &block)
+            end
+          end
+        rescue RestClient::Unauthorized, RestClient::Forbidden => err
+          raise "Access denied. API Response:\n#{err}"
+        end
+
+        puts "Result:\n#{result}" if LeisureKing::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'
+      }
+      # add requesters email address for human communication
+      if LeisureKing::Config.client_email && LeisureKing::Config.client_email != ''
+        h[:from] = LeisureKing::Config.client_email   # email address for human communication
+      end
+      if LeisureKing::Authentication.token
+        h["Authorization"] = "Token #{LeisureKing::Authentication.token}"
+      end
+      return h
+    end
+
+  end
+end

data/lib/leisureking/authentication.rb

@@ -0,0 +1,31 @@
+module LeisureKing::Authentication
+	require 'digest'
+  require 'base64'
+  require 'openssl'
+
+  # The communication layer implements all the methods available in the LeisureKing API
+  class << self
+    attr_accessor :token
+
+    # Set's the default value's to nil and false
+    # @return [Hash] conguration options
+    def init!
+      @defaults = {
+        :@token    => nil,
+      }
+    end
+
+    def get_token
+      body = {
+        apikey: LeisureKing::Config.api_key,
+        secret: LeisureKing::Config.api_secret
+      }
+      result = LeisureKing::API.send_request("authenticate", body)
+      if result["status"] && result["status"] == "OK"
+        self.token = result["data"]["token"]
+      end
+      return result
+    end
+  end
+  init!
+end

data/lib/leisureking/config.rb

@@ -0,0 +1,46 @@
+#
+# Configuration object for storing some parameters required for making transactions
+#
+
+module ::LeisureKing::Config
+  class << self
+    attr_accessor :api_key
+    attr_accessor :api_secret
+    attr_accessor :verbose
+    attr_accessor :api_version
+    attr_accessor :environment
+    attr_accessor :client_email  # Who is making the request? For optional HTTP Header
+    
+
+
+    # Set's the default value's to nil and false
+    # @return [Hash] configuration options
+    def init!
+      @defaults = {
+        :@api_key       => nil,
+        :@api_secret    => nil,
+        :@verbose       => false,
+        :@environment   => :test,
+        :@client_email  => '',
+        :@api_version   => '1l'
+      }
+    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/leisureking/engine.rb

@@ -0,0 +1,15 @@
+module LeisureKing
+  #
+  # 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.leisure_king.api_key  = "12343465sdfgsadr324"
+  #
+  
+  class Engine < ::Rails::Engine
+    isolate_namespace LeisureKing
+    config.leisure_king = LeisureKing::Config
+  end
+end

data/lib/leisureking/version.rb

@@ -0,0 +1,3 @@
+module LeisureKing
+  VERSION = "0.1.0"
+end

data/lib/leisureking.rb

@@ -0,0 +1,23 @@
+module LeisureKing
+end
+
+require "leisureking/version"
+require "leisureking/config"
+require "leisureking/engine" if defined?(Rails) && Rails::VERSION::MAJOR.to_i >= 3
+require "leisureking/authentication"
+require "leisureking/api"
+
+
+module LeisureKing
+  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["LEISURE_KING_API_KEY"]
+    Config.api_secret = ENV["LEISURE_KING_API_SECRET"]
+  end
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: leisureking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henk Meijer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-13 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: Ruby wrapper for the Leisureking API
+email:
+- hmeijer@eskesmedia.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- COMMENTS.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- leisureking.gemspec
+- lib/leisureking.rb
+- lib/leisureking/api.rb
+- lib/leisureking/authentication.rb
+- lib/leisureking/config.rb
+- lib/leisureking/engine.rb
+- lib/leisureking/version.rb
+homepage: 
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Leisureking API
+test_files: []