gillbus-v2 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0b1da1daa5d8dbad4918b9924877bb40492c30b4557daa20464505493b9d78b
+  data.tar.gz: 5ffe4476faafc56d9fca5803b8f45651a5cb14a6ea5a80ace63d9b126ddd2168
+SHA512:
+  metadata.gz: 7ff084e7e3e8cd633467e573f500e5df9d501065b71ba2c5a3126962fef7a33002b8bbd27d2d8ebc6c4886b28326b62d317220136e4111bc93944c292975317c
+  data.tar.gz: a87780270f9bd71b62009114c2dff5c0a88a5b4d1422c57dda33ad96131a599bfde6acf73b1355ee615d9ee72b2c235fb748edde24849f48f6e38dc8c398f3a0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.5
+before_install: gem install bundler

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 khrebtov.dev@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 gillbus-v2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Roman Khrebtov
+
+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,97 @@
+# Gillbus::V2
+
+[![Build Status](https://travis-ci.com/busfor/gillbus-v2-ruby.svg?branch=master)](https://travis-ci.com/busfor/gillbus-v2-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gillbus-v2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gillbus-v2
+
+## Usage
+
+### Authentication
+
+When the access-token is not existed you should use methods `authenticate` or `authenticate!`. Method `authenticate!` raises exception if authentication is failed.
+
+```ruby
+client = Gillbus::V2::Client.new(base_url: 'https://example.com')
+client.authenticate!(
+  username: 'test',
+  password: '12345',
+  lang: 'ru',
+  time_zone: 'Europe/Moscow',
+)
+```
+
+After `authenticate` you need to check the result with `authenticated?`.
+
+```ruby
+client.authenticate(
+  username: 'test',
+  password: '12345',
+  lang: 'ru',
+  time_zone: 'Europe/Moscow',
+)
+client.authenticated?
+# => true | false
+```
+
+After successfull authentication you need to save an access_token.
+
+```ruby
+# only token
+token_string = client.access_token.to_s
+
+# full token data (token type, expiration time)
+token_data = client.access_token.raw_data
+```
+
+When you have an access_token you should be able to pass it to the client.
+
+```ruby
+client = Gillbus::V2::Client.new(
+  base_url: 'https://example.com',
+  access_token: token_string, # or token_data
+)
+```
+
+You need to check the expiration time of the token. If the token becomes expired you should repeat the authentication process again.
+
+```ruby
+if client.access_token.expired?
+  client.authenticate!(...)
+  new_token = client.access_token.raw_data
+  # store new token
+end
+```
+
+The method `expired?` returns `false` when there is no info about the token’s expiration time.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/busfor/gillbus-v2-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Gillbus::V2 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/busfor/gillbus-v2-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gillbus/v2"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/gillbus-v2.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gillbus/v2/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gillbus-v2"
+  spec.version       = Gillbus::V2::VERSION
+  spec.authors       = ["Roman Khrebtov"]
+  spec.email         = ["khrebtov.dev@gmail.com"]
+
+  spec.summary       = "Ruby wrapper for Gillbus GDS API v2"
+  spec.description   = "Ruby wrapper for Gillbus GDS API v2"
+  spec.homepage      = "https://github.com/busfor/gillbus-v2-ruby"
+  spec.license       = "MIT"
+
+  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 'faraday'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "pry"
+end

data/lib/gillbus/v2.rb

@@ -0,0 +1,15 @@
+require "date"
+require "json"
+
+require "faraday"
+
+require "gillbus/v2/version"
+require "gillbus/v2/errors"
+require "gillbus/v2/client"
+
+require "gillbus/v2/parser"
+require "gillbus/v2/structs/base"
+require "gillbus/v2/structs/access_token"
+
+require "gillbus/v2/responses/base"
+require "gillbus/v2/responses/authenticate"

data/lib/gillbus/v2/client.rb

@@ -0,0 +1,74 @@
+module Gillbus::V2
+  class Client
+    attr_reader :base_url
+    attr_reader :access_token
+
+    def initialize(base_url:, access_token: nil)
+      @base_url = base_url
+      @access_token =
+        if access_token.is_a?(Structs::AccessToken)
+          access_token
+        elsif access_token.is_a?(String)
+          Structs::AccessToken.from_token_string(access_token)
+        elsif access_token.is_a?(Hash)
+          Structs::AccessToken.from_raw_data(access_token)
+        end
+    end
+
+    def authenticated?
+      !access_token.nil? && !access_token.expired?
+    end
+
+    def authenticate(username:, password:, lang:, time_zone:)
+      params = {
+        username: username,
+        password: password,
+        lang: lang,
+        timeZone: time_zone,
+      }
+      response = call_api(:post, "/v2/login", params,
+        auth_required: false,
+        response_class: Responses::Authenticate,
+      )
+      @access_token = response.access_token
+      response
+    end
+
+    def authenticate!(**args)
+      response = authenticate(**args)
+      unless authenticated?
+        raise AuthenticationFailed, response.error_message
+      end
+    end
+
+    private
+
+    def call_api(http_method, url, params, auth_required: true, response_class: Responses::Base)
+      raise AuthenticationRequired if auth_required && !authenticated?
+
+      params.reject! { |k, v| v.nil? }
+
+      http_response =
+        begin
+          connection.public_send(http_method) do |request|
+            request.url url
+            params.each do |key, value|
+              request.params[key.to_s] = value
+            end
+            request.headers['accept'] = 'application/json'
+          end
+        rescue Faraday::Error => e
+          raise e
+        end
+
+      response_class.new(http_response)
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: base_url) do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/gillbus/v2/errors.rb

@@ -0,0 +1,5 @@
+module Gillbus::V2
+  class Error < StandardError; end
+  class AuthenticationRequired < Error; end
+  class AuthenticationFailed < Error; end
+end

data/lib/gillbus/v2/parser.rb

@@ -0,0 +1,30 @@
+module Gillbus::V2
+  class Parser
+    def parse_fields(raw_data, fields_settings)
+      result = {}
+      fields_settings.each do |name:, type:, default:|
+        raw_value = raw_data[name.to_s]
+        result[name] =
+          if raw_value.nil?
+            default
+          else
+            coerce_value(raw_value, type)
+          end
+      end
+      result
+    end
+
+    def coerce_value(value, type)
+      case type
+      when :string
+        value.to_s
+      when :integer
+        value.to_i
+      when :date_time_from_timestamp
+        DateTime.strptime(value.to_s, "%s")
+      else
+        raise "Type #{type} not supported"
+      end
+    end
+  end
+end

data/lib/gillbus/v2/responses/authenticate.rb

@@ -0,0 +1,15 @@
+module Gillbus::V2
+  module Responses
+    class Authenticate < Responses::Base
+      def success?
+        http_status == 200 && !access_token.nil?
+      end
+
+      def access_token
+        if json_body["access_token"]
+          Structs::AccessToken.from_raw_data(json_body)
+        end
+      end
+    end
+  end
+end

data/lib/gillbus/v2/responses/base.rb

@@ -0,0 +1,32 @@
+module Gillbus::V2
+  module Responses
+    class Base
+      attr_reader :http_status
+      attr_reader :http_headers
+      attr_reader :http_body
+
+      def initialize(http_response)
+        @http_status = http_response.status
+        @http_headers = http_response.headers
+        @http_body = http_response.body
+      end
+
+      def json_body
+        return @json_body if defined?(@json_body)
+        @json_body = JSON.parse(@http_body) rescue {}
+      end
+
+      def success?
+        http_status == 200
+      end
+
+      def error_code
+        json_body["status"] unless success?
+      end
+
+      def error_message
+        json_body["message"] unless success?
+      end
+    end
+  end
+end

data/lib/gillbus/v2/structs/access_token.rb

@@ -0,0 +1,21 @@
+module Gillbus::V2
+  class Structs::AccessToken < Structs::Base
+    field :access_token, :string
+    field :token_type, :string, default: "Bearer"
+    field :expires_in, :integer
+    field :expires_on, :date_time_from_timestamp
+
+    def self.from_token_string(token)
+      raw_data = { "access_token" => token }
+      from_raw_data(raw_data)
+    end
+
+    def expired?
+      !expires_on.nil? && expires_on <= DateTime.now.new_offset(0)
+    end
+
+    def to_s
+      access_token
+    end
+  end
+end

data/lib/gillbus/v2/structs/base.rb

@@ -0,0 +1,29 @@
+module Gillbus::V2
+  module Structs
+    class Base
+      attr_reader :raw_data
+
+      def initialize(raw_data:, **fields)
+        @raw_data = raw_data
+        fields.each do |field_name, field_value|
+          instance_variable_set(:"@#{field_name}", field_value)
+        end
+      end
+
+      def self.field(name, type, default: nil)
+        attr_reader name
+        @fields_settings ||= []
+        @fields_settings << {
+          name: name,
+          type: type,
+          default: default,
+        }
+      end
+
+      def self.from_raw_data(raw_data)
+        fields = Parser.new.parse_fields(raw_data, @fields_settings)
+        new(raw_data: raw_data, **fields)
+      end
+    end
+  end
+end

data/lib/gillbus/v2/version.rb

@@ -0,0 +1,5 @@
+module Gillbus
+  module V2
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: gillbus-v2
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Roman Khrebtov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Gillbus GDS API v2
+email:
+- khrebtov.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gillbus-v2.gemspec
+- lib/gillbus/v2.rb
+- lib/gillbus/v2/client.rb
+- lib/gillbus/v2/errors.rb
+- lib/gillbus/v2/parser.rb
+- lib/gillbus/v2/responses/authenticate.rb
+- lib/gillbus/v2/responses/base.rb
+- lib/gillbus/v2/structs/access_token.rb
+- lib/gillbus/v2/structs/base.rb
+- lib/gillbus/v2/version.rb
+homepage: https://github.com/busfor/gillbus-v2-ruby
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Gillbus GDS API v2
+test_files: []