plate_api 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 516481a1cbc16f2e26dcd8319b5b682c4f729217ff1f21f48f885ea7ca3f6f74
+  data.tar.gz: 6a5c9663a2185531bbb67b0f2c6a1c55941359ec233a14957ae7855ee83ed2a9
+SHA512:
+  metadata.gz: 2a1894b50e1398d7ada99a89411a51ceadac86c564b3b6556c3491bfcd6c40a1058490d9f6e5dc360b917f238589e312ceb3d255c0b57f2cfdbbd447905be8ae
+  data.tar.gz: 6a71e32bfa9e55a080a8c06286b3c48b9d82c26961bcf280b69da1005309b409d2f3d1c889839053eb134b0173af060ebd8def0d959b4585711656493897f920

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

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 plate_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    plate_api (0.4.0)
+      faraday (~> 0.15.4)
+      faraday_middleware (~> 0.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  plate_api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stufingo
+
+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,39 @@
+# PlateApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/plate_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plate_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plate_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/plate_api.
+
+## License
+
+The 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,29 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plate_api"
+
+# 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
+
+def reload!(print = true)
+  puts 'Reloading ...' if print
+  # Main project directory.
+  root_dir = File.expand_path('..', __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w{lib}
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
+
+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/plate_api/connector.rb

@@ -0,0 +1,32 @@
+require "plate_api/get_request"
+require "plate_api/delete_request"
+require "plate_api/post_request"
+require "plate_api/put_request"
+
+module PlateApi
+  class Connector
+
+
+    def initialize(public_key, secret_key, custom_server=nil)
+      @custom_server = custom_server
+      @public_key = public_key
+      @secret_key = secret_key
+    end
+
+    def get(url="", parameters={})
+      GetRequest.new(@public_key, @secret_key, url, parameters, @custom_server).send
+    end
+
+    def delete(url="", parameters={})
+      DeleteRequest.new(@public_key, @secret_key, url, parameters, @custom_server).send
+    end
+
+    def put(url="", put_params={})
+      PutRequest.new(@public_key, @secret_key, url, put_params, @custom_server).send
+    end
+
+    def post(url="", post_params={})
+      PostRequest.new(@public_key, @secret_key, url, post_params, @custom_server).send
+    end
+  end
+end

data/lib/plate_api/delete_request.rb

@@ -0,0 +1,20 @@
+require "plate_api/request"
+
+module PlateApi
+  class DeleteRequest < Request
+    def initialize(public_key, secret, path, parameters={}, custom_server=nil)
+      super(public_key, secret, "DELETE", path, custom_server)
+
+      sorted_params = parameters.to_a.sort_by{|x| x[0]}
+      @url_parameters = sorted_params.map{|x| "#{x[0]}=#{x[1]}"}.join("&")
+    end
+
+    def url_path
+      "#{@path}?#{@url_parameters}"
+    end
+
+    def url_parameters
+      @url_parameters
+    end
+  end
+end

data/lib/plate_api/get_request.rb

@@ -0,0 +1,20 @@
+require "plate_api/request"
+
+module PlateApi
+  class GetRequest < Request
+    def initialize(public_key, secret, path, parameters={}, custom_server=nil)
+      super(public_key, secret, "GET", path, custom_server)
+
+      sorted_params = parameters.to_a.sort_by{|x| x[0]}
+      @url_parameters = sorted_params.map{|x| "#{x[0]}=#{x[1]}"}.join("&")
+    end
+
+    def url_path
+      "#{@path}?#{@url_parameters}"
+    end
+
+    def url_parameters
+      @url_parameters
+    end
+  end
+end

data/lib/plate_api/post_request.rb

@@ -0,0 +1,17 @@
+require "plate_api/request"
+
+module PlateApi
+  class PostRequest < Request
+
+    def initialize(public_key, secret, path, parameters={}, custom_server=nil)
+      super(public_key, secret, "POST", path, custom_server)
+
+      @post_parameters = parameters.to_json
+    end
+
+    def extra_request_options(request)
+      request.headers['Content-Type'] = 'application/json'
+      request.body = @post_parameters
+    end
+  end
+end

data/lib/plate_api/put_request.rb

@@ -0,0 +1,17 @@
+require "plate_api/request"
+
+module PlateApi
+  class PutRequest < Request
+
+    def initialize(public_key, secret, path, parameters={}, custom_server=nil)
+      super(public_key, secret, "PUT", path, custom_server)
+
+      @put_parameters = parameters.to_json
+    end
+
+    def extra_request_options(request)
+      request.headers['Content-Type'] = 'application/json'
+      request.body = @put_parameters
+    end
+  end
+end

data/lib/plate_api/request.rb

@@ -0,0 +1,69 @@
+require "faraday"
+require 'faraday_middleware'
+require 'time'
+require "base64"
+require "openssl"
+
+
+module PlateApi
+  class Request
+    DefaultApiBaseEndpoint = "https://www.startwithplate.com/api/v2"
+
+    def initialize(public_key, secret, method, path, custom_server=nil)
+      base_api_endpoint = custom_server ? custom_server : DefaultApiBaseEndpoint
+
+      @connection = ::Faraday.new(url: base_api_endpoint) do |faraday|
+        faraday.response    :json
+        faraday.adapter     Faraday.default_adapter
+      end
+
+      @public_key = public_key
+      @secret = secret
+      @method = method
+      @path = strip_path(path)
+    end
+
+    def send
+      response = @connection.send(@method.downcase) do |request|
+        request.url url_path
+        request.headers['Date'] = request_date
+        request.headers['Authorization'] = calculate_signature
+        request.headers['Content-Type'] = 'application/json'
+        extra_request_options(request)
+      end
+
+      return response.body
+    end
+
+    def request_date
+      @date ||= Time.now.httpdate
+    end
+
+    def calculate_signature
+      string_to_sign = "#{@method}\n" +
+                       "#{@connection.host}\n" +
+                       "#{@connection.path_prefix}/#{@path}\n" +
+                       "#{url_parameters}\n" +
+                       "#{request_date}"
+      signature = Base64.strict_encode64(OpenSSL::HMAC.digest("SHA512", @secret, string_to_sign))
+      return "hmac #{@public_key}:#{signature}"
+    end
+
+    private
+
+    def url_path
+      @path
+    end
+
+    def url_parameters
+      ""
+    end
+
+    def extra_request_options(request)
+    end
+
+    def strip_path(path)
+      path.gsub(/^\/|\/$/, '')
+    end
+  end
+end

data/lib/plate_api/version.rb

@@ -0,0 +1,3 @@
+module PlateApi
+  VERSION = "0.4.0"
+end

data/lib/plate_api.rb

@@ -0,0 +1,5 @@
+require "plate_api/version"
+require "plate_api/connector"
+
+module PlateApi
+end

data/plate_api.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "plate_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = 'plate_api'
+  spec.version     = PlateApi::VERSION
+  spec.date        = '2019-01-05'
+  spec.summary     = "Connector for the Plate API"
+  spec.description = "This gem can be used to connect to the Plate API. It takes care
+  of the authentication procedure. "
+  spec.authors     = ["David Kortleven"]
+  spec.email       = 'david@getplate.com'
+  spec.files       = ["lib/plate_api.rb"]
+  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://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "faraday", "~> 0.15.4"
+  spec.add_dependency "faraday_middleware", "~> 0.13.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: plate_api
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- David Kortleven
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: "This gem can be used to connect to the Plate API. It takes care\n  of
+  the authentication procedure. "
+email: david@getplate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/plate_api.rb
+- lib/plate_api/connector.rb
+- lib/plate_api/delete_request.rb
+- lib/plate_api/get_request.rb
+- lib/plate_api/post_request.rb
+- lib/plate_api/put_request.rb
+- lib/plate_api/request.rb
+- lib/plate_api/version.rb
+- plate_api.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Connector for the Plate API
+test_files: []