beyond_api 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc6513e97ac7ec622da979d66f36a36b71d6febf5190408ece1a5fafcf2890e2
+  data.tar.gz: 1e13365c3d4ac79de3a813de39ee413d228a09fb5f2959eaca203ad89f7cff70
+SHA512:
+  metadata.gz: 8185d244d86bbc9931a30d0d611c9c1de3eb00542804f774b43336cb18814be42e087b38a110a4f8646257ed2bd6880984d3938c07f96f70eafcab765acdbb54
+  data.tar.gz: 962ad63c5b9e943b60d9a4e17bb565c0e3beef244bd0d269b24da076a4cb90d5612644da73508b2fce4cf3d3f1ce4524d139d72f23ee73a5d9b3f304c238ea9a

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Environment variables
+.env
+
+# Apple file system
+.DS_Store

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

data/.yardopts

@@ -0,0 +1 @@
+--tag beyond_api.scopes:"Scopes"

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 0.1.0.pre
+
+* features
+  * All endpoints offered by the Beyond API

data/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to Beyond API Ruby Client
+
+We love pull requests from everyone. Here are some ways _you_ can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/ePages-de/beyond_api-ruby_client/issues
+
+## Submitting an Issue
+
+* We use the [GitHub issue tracker][issues] to track bugs and features.
+* Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.
+* When submitting a bug report, please include a [Gist][] that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Cleaning up issues
+
+* Issues that have no response from the submitter will be closed after 30 days.
+* Issues will be closed once they're assumed to be fixed or answered. If the maintainer is wrong, it can be opened again.
+* If your issue is closed by mistake, please understand and explain the issue. We will happily reopen the issue.
+
+## Submitting a Pull Request
+
+1. [Fork][fork] the [official repository][repo].
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Add, commit, and push your changes.
+5. [Submit a pull request.][pr]
+
+## Notes
+
+* Please don't update the Gem version.
+
+[repo]: https://github.com/ePages-de/beyond_api-ruby_client/tree/master
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/
+
+Inspired by https://github.com/thoughtbot/factory_bot/blob/master/CONTRIBUTING.md

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    beyond_api (0.1.0.pre)
+      faraday (~> 0.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    faker (2.4.0)
+      i18n (~> 1.6.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    multipart-post (2.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  beyond_api!
+  bundler (~> 2.0)
+  dotenv (~> 2.7)
+  faker (~> 2.2)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2019 ePages GmbH
+
+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,51 @@
+# Beyond API Ruby Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "beyond_api"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Next, you need to run the generator:
+
+```bash
+$ rails generate beyond_api:install
+```
+
+This will generate the configuration file on `config/initializers/beyond_api.rb`. Set the `client_id` and `client_secret` values to get started.
+
+> ⚠️ **Be careful!** Don't expose your `client_id` and `client_secret` or publish them on GitHub or any other service. Use [Rails Credentials](https://guides.rubyonrails.org/security.html#custom-credentials) or a gem like [dotenv](https://github.com/bkeepers/dotenv) to save your environment variables.
+
+To install the gem manually from your shell, run:
+
+```bash
+$ gem install beyond_api
+```
+
+## Documentation
+
+## Development
+
+Check out the repo an 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`.
+
+## Contributing
+
+Please see [CONTRIBUTING](https://github.com/ePages-de/beyond_api-ruby_client/blob/master/CONTRIBUTING.md).
+
+## Changelog
+
+Beyond API's changelog is available [here](https://github.com/ePages-de/beyond_api-ruby_client/blob/master/CHANGELOG.md).
+
+## License
+
+beyond_api is Copyright © 2019 ePages GmbH. It is free software, and may be redistributed under the terms specified in the [LICENSE](https://github.com/ePages-de/beyond_api-ruby_client/blob/master/LICENSE) file.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+YARD::Rake::YardocTask.new do |t|
+ t.files   = ['lib/**/*.rb']
+end

data/beyond_api.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "beyond_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "beyond_api"
+  spec.version       = BeyondApi::VERSION
+  spec.authors       = ["Unai Abrisketa", "Kathia Salazar", "German San Emeterio"]
+
+  spec.summary       = "Ruby client to access the Beyond API"
+  spec.homepage      = "https://github.com/ePages-de/beyond_api-ruby_client"
+
+  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.required_ruby_version = ">= 2.5.1"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "yard",    "~> 0.9"
+  spec.add_development_dependency "faker",   "~> 2.2"
+  spec.add_development_dependency "dotenv",  "~> 2.7"
+
+  spec.add_dependency "faraday", "~> 0.15"
+end

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv/load"
+require "beyond_api"
+
+unless ENV["CLIENT_ID"].nil? and ENV["CLIENT_SECRET"].nil?
+  BeyondApi.setup do |config|
+    config.client_id = ENV["CLIENT_ID"]
+    config.client_secret = ENV["CLIENT_SECRET"]
+    config.remove_response_links = true
+    config.remove_response_key_underscores = true
+    config.object_struct_responses = false
+  end
+end
+
+require "pry"
+Pry.start

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/beyond_api.rb

@@ -0,0 +1,37 @@
+require "beyond_api/version"
+
+require "beyond_api/connection"
+require "beyond_api/request"
+require "beyond_api/session"
+
+require "beyond_api/ext"
+require "beyond_api/utils"
+
+module BeyondApi
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.setup
+    self.configuration ||= Configuration.new
+
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :client_id, :client_secret, :open_timeout, :timeout,  :remove_response_links,
+                  :remove_response_key_underscores, :object_struct_responses
+
+    def initialize
+      @client_id = nil
+      @client_secret = nil
+      @open_timeout = 2
+      @timeout = 5
+      @remove_response_links = false
+      @remove_response_key_underscores = false
+      @object_struct_responses = false
+    end
+  end
+end

data/lib/beyond_api/connection.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module BeyondApi
+  class Connection
+    def self.default
+      Faraday.new(ssl: { verify: true }) do |faraday|
+        faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i
+        faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
+        faraday.headers['Accept'] = 'application/json'
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.request(:multipart)
+        faraday.request(:url_encoded)
+        faraday.adapter(:net_http)
+      end
+    end
+
+    def self.token
+      Faraday.new(ssl: { verify: true }) do |faraday|
+        faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i
+        faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
+        faraday.headers['Accept'] = 'application/json'
+        faraday.adapter(:net_http)
+        faraday.basic_auth(BeyondApi.configuration.client_id,
+                           BeyondApi.configuration.client_secret)
+      end
+    end
+  end
+end

data/lib/beyond_api/ext.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class Hash
+  def deep_transform_keys(&block)
+    result = {}
+    each do |key, value|
+      result[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys(&block) : value
+    end
+    result
+  end
+
+  def camelize_keys
+    deep_transform_keys { |key| key.to_s.camelize(false) }
+  end
+
+  def underscorize_keys
+    deep_transform_keys { |key| key.to_s.underscore }
+  end
+end
+
+class String
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  def camelize(uppercase_first_letter = true)
+    string = self
+    if uppercase_first_letter
+      string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+    else
+      string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+    end
+    string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
+  end
+end

data/lib/beyond_api/request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+
+module BeyondApi
+  class Request
+    class << self
+      [:get, :delete].each do |method|
+        define_method(method) do |session, path, params = {}|
+          response = BeyondApi::Connection.default.send(method) do |request|
+            request.url(session.api_url + path)
+            request.headers['Authorization'] = "Bearer #{ session.access_token }"
+            request.params = params.to_h.camelize_keys
+          end
+
+          [response.body.blank? ? nil : JSON.parse(response.body), response.status]
+        end
+      end
+
+      [:post, :put, :patch].each do |method|
+        define_method(method) do |session, path, body = {}, params = {}|
+          response = BeyondApi::Connection.default.send(method) do |request|
+            request.url(session.api_url + path)
+            request.headers['Authorization'] = "Bearer #{ session.access_token }"
+            request.params = params.to_h.camelize_keys
+            request.body = body.to_h.camelize_keys.to_json
+          end
+
+          [response.body.blank? ? nil : JSON.parse(response.body), response.status]
+        end
+      end
+    end
+
+    def self.upload(session, path, file_binary, content_type, params)
+      response = BeyondApi::Connection.default.post do |request|
+        request.url(session.api_url + path)
+        request.headers['Authorization'] = "Bearer #{ session.access_token }"
+        request.headers['Content-Type'] = content_type
+        request.params = params.to_h.camelize_keys
+        request.body = file_binary
+      end
+
+      [response.body.blank? ? nil : JSON.parse(response.body), response.status]
+    end
+
+    def self.token(url, params)
+      response = BeyondApi::Connection.token.post do |request|
+        request.url(url)
+        request.params = params
+      end
+
+      [response.body.blank? ? nil : JSON.parse(response.body), response.status]
+    end
+  end
+end