gpdb_client 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8c0ce46227d9f72cfc83cf8b9a352f9a5bb1287a9ec4cabe89840dad444b498
+  data.tar.gz: 33dd7334bae03b1251053eb1e95dc5af4c455d07a5f64379e62e7fa205c76492
+SHA512:
+  metadata.gz: fbdbe1dff6ccf3677260e0256eb64ae0388125f3ab6022c6f689d4e44d4dd51bd66467a057cfd87de8532a62b52b2be7e27377f5882b5a973ea61ae7b0662134
+  data.tar.gz: aaaf2a283bfc9e173c9d7f1a8fa9aa2590b22716f5d8602ceaf370f213c12cc9bd6905c09f1d5745bb6bee0ce7dfca92d9d1bdcf546a9a9ac39ae12f77262a68

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+
+# rspec failure tracking
+.rspec_status
+.rspec
+
+.vscode/
+.idea/

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

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    gpdb_client (0.1)
+      activesupport
+      faraday
+      jwt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.7)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jwt (2.2.2)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    ruby2_keywords (0.0.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.9.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  gpdb_client!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.9.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 alexander.yundin
+
+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,182 @@
+# Gpdb Client
+
+The gem is a simple wrapper around NameCoach GPDB (General Pronunciation Database) API.
+It is useful to external developers who wish to add NameCoach services to an application. 
+
+For more information on NameCoach GPDB APi, you can visit [documentation page](https://namecoachgpdb.docs.apiary.io/#).
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [API](#api)
+  - [Pronunciations](#pronunciations)
+    - [Simple search](#simple-search)
+    - [Complex search](#complex-search)
+    - [Create](#create-a-pronunciation)
+  - [Recording requests](#recording-request)
+    - [Create](#create-recording-request)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gpdb_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gpdb_client
+
+#### Required ENV variables:
+
+`GPDB_API_URL`
+
+`GPDB_NAMESPACE` - specifies the API version (e.g. `'/api/public/v1'`)
+
+`GPDB_ACCESS_KEY_ID`, `GPDB_SECRET_ACCESS_KEY` - 
+During your API onboarding with NameCoach, you will be given these values
+
+## Usage
+
+You need to create a client instance to perform requests. Basic example:
+
+    gpdb_client = Gpdb::REST::Client.new
+    
+    result = gpdb_client.pronunciations.simple_search(target: 'Alex', app_sig: 'app_sig', app_type: 'app_type')
+
+    # Each response has common methods:
+    result.success? # => true
+    result.status   # => 200
+    
+    # As well as specific response attributes
+    result.target   # => Gpdb::REST::Pronunciation::Target instance
+
+
+The client instance contains two resources: `pronunciations` and `recording_requests`.
+Each resource has its own unique methods which are described below. 
+
+You can find detailed information about all possible parameters and the response format
+on the [documentation page](https://namecoachgpdb.docs.apiary.io/#).
+Links to the specific methods are placed at the end of each paragraph.
+
+## API
+
+### Pronunciations
+
+#### Simple search
+
+Quick / simple request to get pronunciation for a single target.
+
+    result = gpdb_client.pronunciations.simple_search(
+        target: 'Alex',
+        app_sig: 'app_sig',
+        app_type: 'app_type'
+    )
+    
+    result.meta
+    # => Name Parser and Recommendation Model version info
+    
+    result.target
+    # => Gpdb::REST::Pronunciation::Target instance that contains target attributes
+    
+    pronunciations = result.target.pronunciations
+    # => an array of Gpdb::REST::Pronunciation::Model instances
+    
+    pronunciations.first.audio_url
+    # => a link to an audio
+    
+[Simple search documentation](https://namecoachgpdb.docs.apiary.io/#reference/pronunciations/simple-search/simple-search)
+
+#### Complex search
+
+Perform a search in GPDB given between 1 and 10 search targets.
+
+    result = gpdb_client.pronunciations.complex_search(
+        targets: [
+            {
+              target: "praveen",
+              target_type_sig:  "person_first_name"
+            },
+            {
+              target: "rob",
+              target_type_sig:  "person_first_name"
+            }
+        ],
+        application_context: {
+            app_type_sig: "myCoolApp",
+            instance_sig: "anInstanceID"
+        }
+    )
+    
+    result.target_results
+    # => an array of Gpdb::REST::Pronunciation::Target instances
+    
+    result.meta
+    # => Name Parser and Recommendation Model version info
+    
+[Complex search documentation](https://namecoachgpdb.docs.apiary.io/#reference/pronunciations/complex-search/complex-search)
+
+#### Create a pronunciation
+
+In order to create recordings, you will need to provide audio data in the base64 format.
+
+    result = gpdb_client.pronunciations.create(
+        name: 'mary',
+        target_type_sig: 'person_first_name',
+        base64_audio: base64_audio_text,
+        application_context: {
+            app_type_sig: 'myCoolApp',
+            instance_sig: 'anInstanceID'
+        },
+        user_context: {
+            signature: 'u_sign'
+        },
+        name_owner_context: {
+            signature: 'u_name_own'
+        }
+    )
+    
+    result.pronunciation
+    # => Gpdb::REST::Pronunciation::Model instance
+    
+    result.errors # will contain errors if attrobutes you provided are not valid
+    # => { audio_data: "can't be blank" }
+
+[Create a pronunciation documentation](https://namecoachgpdb.docs.apiary.io/#reference/pronunciations/create-a-pronunciation/create-a-pronunciation)
+
+### Recording request
+
+#### Create recording request
+
+If we are missing a pronunciation needed for you, you can request it
+
+    result = gpdb_client.recording_requests.create(
+        target: 'franka',
+        target_type_sig: 'person_first_name',
+        target_owner_context: {
+            signature: 'sign'
+        },
+        user_context: {
+            signature: 'u_sign'
+        },
+        application_context: {
+            app_type_sig: 'myCoolApp',
+            instance_sig: 'anInstanceID'
+        }
+    )
+    
+    result.recording_request
+    # Gpdb::REST::RecordingRequest::Model instance
+    
+    result.errors # will contain errors if attributes you provided are not valid
+    # => { target: "can't be blank" }
+
+[Recording request documentation](https://namecoachgpdb.docs.apiary.io/#reference/recording-requests/recording-requests/recording-requests)
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gpdb_client"
+
+# 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/gpdb_client.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gpdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gpdb_client'
+  spec.version       = GpdbClient::VERSION
+  spec.authors       = ['NameCoachDevTeam']
+  spec.email         = ['dev-team@name-coach.com']
+
+  spec.summary       = %q{Summary}
+  spec.description   = %q{Description}
+  spec.homepage      = ''
+  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_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.9.2'
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'jwt'
+end

data/lib/gpdb.rb

@@ -0,0 +1,9 @@
+module Gpdb
+  def self.configuration
+    Configuration.instance
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/gpdb/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gpdb
+  class Configuration
+    include Singleton
+
+    attr_accessor :namespace
+    attr_accessor :api_url
+    attr_accessor :access_key_id
+    attr_accessor :secret_access_key
+
+    def initialize
+      self.api_url = ENV.fetch('GPDB_API_URL')
+      self.namespace = ENV.fetch('GPDB_NAMESPACE')
+      self.access_key_id = ENV.fetch('GPDB_ACCESS_KEY_ID')
+      self.secret_access_key = ENV.fetch('GPDB_SECRET_ACCESS_KEY')
+    end
+
+    def credentials
+      Credentials.new(access_key_id, secret_access_key)
+    end
+  end
+end

data/lib/gpdb/credentials.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Gpdb
+  class Credentials
+    def initialize(access_key_id, secret_access_key)
+      @access_key_id = access_key_id
+      @secret_access_key = secret_access_key
+    end
+
+    def signature
+      ::JWT.encode(
+        { ts: Time.now.since(30.seconds).to_i * 1000 },
+        @secret_access_key,
+        'HS256',
+        { access_key_id: @access_key_id }
+      )
+    end
+
+    def signature_header
+      "Bearer:#{signature}"
+    end
+
+    def signature_url_encoded
+      { signature: signature }.to_query
+    end
+  end
+end

data/lib/gpdb/http_client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Gpdb
+  class HttpClient
+    class JsonParseMiddleware < ::Faraday::Response::Middleware
+      def on_complete(env)
+        env[:body] = JSON.parse(env[:body], symbolize_names: true) if env.parse_body?
+      end
+    end
+
+    class HeadersMiddleware < ::Faraday::Middleware
+      def call(env)
+        env[:request_headers]['Content-Type'] = if [:post, :put].include?(env.method)
+                                                  'multipart/form-data'
+                                                else
+                                                  'application/json'
+                                                end
+
+        env[:request_headers]['Accept'] = 'application/json'
+        env[:request_headers]['User-Agent'] = "gpdb-api-client/#{GpdbClient::VERSION}"
+
+        @app.call(env)
+      end
+    end
+
+    def request(request)
+      conn = Faraday.new(url: request.api_url) do |f|
+        f.headers = request.headers
+        f.use(HeadersMiddleware)
+
+        f.request(:multipart)
+        f.request(:url_encoded)
+
+        f.use(JsonParseMiddleware)
+        f.adapter(Faraday.default_adapter)
+      end
+
+      conn.public_send(request.method, request.path, request.params)
+    end
+  end
+end

data/lib/gpdb/model.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gpdb
+  class Model
+    attr_accessor :created_at, :updated_at, :id
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        public_send("#{name}=", value)
+      end
+    end
+  end
+end

data/lib/gpdb/rest/base_resource.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    class BaseResource
+      attr_accessor :client
+
+      def initialize(api_client)
+        self.client = api_client
+      end
+    end
+  end
+end

data/lib/gpdb/rest/client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    class Client
+      attr_accessor :http_client
+      attr_accessor :recording_requests, :pronunciations
+
+      def initialize
+        self.http_client = HttpClient.new
+
+        self.recording_requests = Gpdb::REST::RecordingRequest::Resource.new(self)
+        self.pronunciations = Gpdb::REST::Pronunciation::Resource.new(self)
+      end
+
+      def request(request, namespace: Gpdb.configuration.namespace)
+        request.api_url = Gpdb.configuration.api_url
+        request.path    = "#{namespace}#{request.path}"
+        request.headers = { 'Authorization': Gpdb.configuration.credentials.signature_header }
+
+        response = http_client.request(request)
+
+        Response.new(body: response.body, status: response.status, _response: response)
+      end
+    end
+  end
+end

data/lib/gpdb/rest/pronunciation/model.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module Pronunciation
+      class Model < ::Gpdb::Model
+        attr_accessor :id, :created_at, :updated_at, :audio_url, :allow_user_responses,
+                      :language_metadata, :phonetic_transcriptions, :user_responses,
+                      :audio_source, :audio_owner_signature, :name_owner_signature, :name_text
+
+        def initialize(attributes = {})
+          self.id                      = attributes[:id]
+          self.audio_url               = attributes[:audio_url]
+          self.allow_user_responses    = attributes[:allow_user_responses]
+          self.language_metadata       = attributes[:language_metadata]
+          self.phonetic_transcriptions = attributes[:phonetic_transcriptions]
+          self.user_responses          = attributes[:user_responses]
+          self.created_at              = attributes[:created_at]
+          self.updated_at              = attributes[:updated_at]
+
+          # The next attributes are present only for the 'create' action
+          self.audio_source          = attributes[:audio_source]
+          self.audio_owner_signature = attributes[:audio_owner_signature]
+          self.name_owner_signature  = attributes[:name_owner_signature]
+          self.name_text             = attributes[:name_text]
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/pronunciation/resource.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module Pronunciation
+      class Resource < Gpdb::REST::BaseResource
+        # @param [String] target
+        # @param [String] app_sig
+        # @param [String] app_type
+        # @param [Hash] options
+        # @return [Gpdb::REST::Pronunciation::TargetResponse]
+        def simple_search(target:, app_sig:, app_type:, **options)
+          request = ::Gpdb::REST::Request.new(
+            method: :get,
+            path:   '/pronunciations',
+            params: {
+              target:               target,
+              application_sig:      app_sig,
+              application_type_sig: app_type
+            }.merge(options)
+          )
+
+          ::Gpdb::REST::Pronunciation::TargetResponse.new(
+            client.request(request, namespace: 'api/public/v1')
+          )
+        end
+
+        # @param [Array] targets
+        # @param [Object] application_context
+        # @param [Object] user_context
+        # @return [Gpdb::REST::Pronunciation::TargetListResponse]
+        def complex_search(targets:, application_context:, user_context: {})
+          request = ::Gpdb::REST::Request.new(
+            method: :post,
+            path:   '/pronunciations/search',
+            params: {
+              targets:             targets,
+              application_context: application_context,
+              user_context:        user_context
+            }
+          )
+
+          ::Gpdb::REST::Pronunciation::TargetListResponse.new(
+            client.request(request, namespace: 'api/public/v1')
+          )
+        end
+
+        # @param [String] name
+        # @param [String] base64_audio
+        # @param [Object] application_context
+        # @param [Object] user_context
+        # @param [Hash] options
+        # @return [Gpdb::REST::Pronunciation::Response]
+        def create(name:, base64_audio:, application_context:, user_context:, **options)
+          request = ::Gpdb::REST::Request.new(
+            method: :post,
+            path:   '/pronunciations',
+            params: {
+              name_text:           name,
+              audio_data:          base64_audio,
+              application_context: application_context,
+              user_context:        user_context
+            }.merge(options)
+          )
+
+          ::Gpdb::REST::Pronunciation::Response.new(
+            client.request(request, namespace: 'api/public/v1')
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/pronunciation/response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module Pronunciation
+      class Response < ::Gpdb::REST::Response
+        attr_accessor :pronunciation
+
+        def initialize(*args)
+          super
+
+          self.pronunciation = Gpdb::REST::Pronunciation::Model.new(body) if success?
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/pronunciation/target.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module Pronunciation
+      class Target < ::Gpdb::Model
+        attr_accessor :pagination_info, :origin, :links,
+                      :transcription, :id, :pronunciations
+
+        def initialize(attributes = {})
+          self.pagination_info = attributes[:target_pagination_info]
+          self.origin          = attributes[:target_origin]
+          self.links           = attributes[:links]
+          self.transcription   = attributes[:target_transcription]
+          self.id              = attributes[:target_id]
+          self.pronunciations  = attributes[:pronunciations]&.map do |pronunciation|
+            ::Gpdb::REST::Pronunciation::Model.new(pronunciation)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/pronunciation/target_list_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module Pronunciation
+      class TargetListResponse < ::Gpdb::REST::Response
+        attr_accessor :target_results, :meta
+
+        def initialize(*args)
+          super
+
+          return unless success?
+
+          self.target_results = body[:target_results].map { |target| ::Gpdb::REST::Pronunciation::Target.new(target) }
+          self.meta = body[:meta]
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/pronunciation/target_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module Pronunciation
+      class TargetResponse < ::Gpdb::REST::Response
+        attr_accessor :target, :meta
+
+        def initialize(*args)
+          super
+
+          return unless success?
+
+          self.target = ::Gpdb::REST::Pronunciation::Target.new(body[:target_result])
+          self.meta = body[:meta]
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/recording_request/model.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module RecordingRequest
+      class Model < ::Gpdb::Model
+        attr_accessor :recording_request_id, :target, :target_type_sig,
+                      :target_owner_context, :user_context, :application_context
+
+        def initialize(attributes = {})
+          self.id                   = attributes[:recording_request_id]
+          self.target               = attributes[:target]
+          self.target_type_sig      = attributes[:target_owner_context]
+          self.user_context         = attributes[:user_context]
+          self.application_context  = attributes[:application_context]
+          self.target_owner_context = attributes[:target_owner_context]
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/recording_request/resource.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module RecordingRequest
+      class Resource < Gpdb::REST::BaseResource
+        # @param [String] target
+        # @param [String] target_type_sig
+        # @param [Object] target_owner_context
+        # @param [Object] application_context
+        # @param [Object] user_context
+        # @return [Gpdb::REST::RecordingRequest::Response]
+        def create(target:, target_type_sig:, target_owner_context:, application_context:, user_context:)
+          request = ::Gpdb::REST::Request.new(
+            method: :post,
+            path:   '/recording_requests',
+            params: {
+              target:               target,
+              target_type_sig:      target_type_sig,
+              target_owner_context: target_owner_context,
+              application_context:  application_context,
+              user_context:         user_context
+            }
+          )
+
+          ::Gpdb::REST::RecordingRequest::Response.new(
+            client.request(request, namespace: 'api/public/v1')
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/recording_request/response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    module RecordingRequest
+      class Response < ::Gpdb::REST::Response
+        attr_accessor :recording_request
+
+        def initialize(*args)
+          super
+
+          self.recording_request = Gpdb::REST::RecordingRequest::Model.new(body) if success?
+        end
+      end
+    end
+  end
+end

data/lib/gpdb/rest/request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    class Request < ::Gpdb::Model
+      attr_accessor :api_url, :path, :params, :method, :headers
+
+      def method
+        @method.downcase.to_sym
+      end
+    end
+  end
+end

data/lib/gpdb/rest/response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gpdb
+  module REST
+    class Response < ::Gpdb::Model
+      attr_accessor :body, :status, :_response, :errors
+
+      delegate :success?, to: :_response
+
+      def initialize(*args)
+        if args[0].is_a?(Hash)
+          super
+        elsif args[0].is_a?(::Gpdb::REST::Response)
+          super(
+            body:      args[0].body,
+            status:    args[0].status,
+            _response: args[0]._response
+          )
+        end
+
+        self.errors = body[:errors] if body.is_a?(Hash)
+      end
+
+      def to_s
+        "<#{self.class} #{status} #{_response.reason_phrase} #{_response.headers['x-runtime']}s #{body.present? ? 'with body' : nil}>"
+      end
+
+      def inspect
+        to_s
+      end
+    end
+  end
+end

data/lib/gpdb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GpdbClient
+  VERSION = '0.1'
+end

data/lib/gpdb_client.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext/module'
+require 'jwt'
+require 'faraday'
+
+require 'gpdb'
+require 'gpdb/credentials'
+require 'gpdb/configuration'
+require 'gpdb/http_client'
+require 'gpdb/model'
+require 'gpdb/version'
+
+require 'gpdb/rest/base_resource'
+require 'gpdb/rest/client'
+require 'gpdb/rest/request'
+require 'gpdb/rest/response'
+
+require 'gpdb/rest/recording_request/model'
+require 'gpdb/rest/recording_request/resource'
+require 'gpdb/rest/recording_request/response'
+
+require 'gpdb/rest/pronunciation/model'
+require 'gpdb/rest/pronunciation/resource'
+require 'gpdb/rest/pronunciation/response'
+require 'gpdb/rest/pronunciation/target'
+require 'gpdb/rest/pronunciation/target_response'
+require 'gpdb/rest/pronunciation/target_list_response'
+
+module GpdbClient; end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: gpdb_client
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- NameCoachDevTeam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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: jwt
+  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'
+description: Description
+email:
+- dev-team@name-coach.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gpdb_client.gemspec
+- lib/gpdb.rb
+- lib/gpdb/configuration.rb
+- lib/gpdb/credentials.rb
+- lib/gpdb/http_client.rb
+- lib/gpdb/model.rb
+- lib/gpdb/rest/base_resource.rb
+- lib/gpdb/rest/client.rb
+- lib/gpdb/rest/pronunciation/model.rb
+- lib/gpdb/rest/pronunciation/resource.rb
+- lib/gpdb/rest/pronunciation/response.rb
+- lib/gpdb/rest/pronunciation/target.rb
+- lib/gpdb/rest/pronunciation/target_list_response.rb
+- lib/gpdb/rest/pronunciation/target_response.rb
+- lib/gpdb/rest/recording_request/model.rb
+- lib/gpdb/rest/recording_request/resource.rb
+- lib/gpdb/rest/recording_request/response.rb
+- lib/gpdb/rest/request.rb
+- lib/gpdb/rest/response.rb
+- lib/gpdb/version.rb
+- lib/gpdb_client.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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Summary
+test_files: []