frederick_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3de672e56c6302f235bed63e48c4dd11978344ea
+  data.tar.gz: 173a72637912e59ae28c5f99eca47d5c6207dfff
+SHA512:
+  metadata.gz: 076b3051e48620744b08af1d2aae2571edecb87688341d4b748c92503157d6c46e52c4522c5ac0016a64044fcf9a30440ca31cd8b186e805a6608b1b5e0f5446
+  data.tar.gz: 02b1230c8352a91edda3268866b185e54e4397b2185a0d37eaf896bc64f6b72c8b6d61a976865984db9ef70c66f8a0e77ee244d83e979913b83634f2e2d69698

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009-2017 Frederick Labs LLC
+
+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,86 @@
+[ ![Codeship Status for BookerSoftwareInc/frederick_api_gem](https://app.codeship.com/projects/43a5ea40-2b13-0135-7e95-4afd89638027/status?branch=master)](https://app.codeship.com/projects/224007)
+
+```text
+ _____             _           _      _         _    ____ ___
+|  ___| __ ___  __| | ___ _ __(_) ___| | __    / \  |  _ \_ _|___
+| |_ | '__/ _ \/ _` |/ _ \ '__| |/ __| |/ /   / _ \ | |_) | |/ __|
+|  _|| | |  __/ (_| |  __/ |  | | (__|   <   / ___ \|  __/| |\__ \
+|_|  |_|  \___|\__,_|\___|_|  |_|\___|_|\_\ /_/   \_\_|  |___|___/
+```
+
+
+This gem provides a client for Frederick's V2 APIs.
+
+Note: Our V2 APIs have not yet been released for use by customers or partners. See
+[Frederick Developers](https://developers.hirefrederick.com) for supported APIs and documentation.
+
+## Installation
+
+Put this in your Gemfile:
+
+```ruby
+gem 'frederick_api'
+```
+
+You're now ready to go with Frederick's v2 API!
+
+### Configuring FrederickAPI
+
+You can use `FrederickAPI.configure` or environment variables
+to configure the Frederick API client.
+
+```ruby
+# config/initializers/frederick_api.rb
+...
+FrederickAPI.configure do |c|
+  c.base_url = 'https://api.hirefrederick.com'
+  c.api_key = '1234-5678-1234-5678-1234-5678'
+end
+...
+```
+
+Environment variables can also be used:
+  * `FREDERICK_API_BASE_URL`: Same as `base_url` above
+  * `FREDERICK_API_KEY`: Same as `api_key` above
+  
+Environments:
+  * For testing (default), use `FREDERICK_API_BASE_URL = https://api.staging.hirefrederick.com`
+  * For production, use `FREDERICK_API_BASE_URL = https://api.hirefrederick.com`
+  
+NOTE: You must specify the production base URL of `https://api.hirefrederick.com` in order to use this gem with
+Frederick's production API.
+
+## Usage
+
+Frederick V2 Resources correspond to ([JSON API](http://jsonapi.org/) compatible) APIs and use the
+[json_api_client](https://github.com/chingor13/json_api_client) gem under the hood, so provide access
+to standard "ActiveRecord-like" functionaliy such as `.create`, `.find`, `.where`, `.order`, `.includes` to create, find,
+filter, sort, and include relationships.
+
+### Access Tokens
+
+An access token is required to access resources on behalf of a use. Use `Resource.with_access_token { ... }` to make
+requests with an access token.
+
+```ruby
+location_id = '6fdf0530-3e4e-46f1-9d11-5f90c48a50dc'
+access_token = '9jsdo320fjfkfdksls30dfdcd919bcaa1b7804dbbebda0'
+FrederickAPI::V2::Location.with_access_token(access_token) do
+  # Fetch a location
+  location = FrederickAPI::V2::Location.find(location_id)
+  # => #<FrederickAPI::V2::Location:0x007fd2f29a7618>
+  
+  location.name
+  # => 'Bizzy Biz'
+  
+  # Update a location
+  location.name = 'Biz Bizziest'
+  location.save
+  # => true
+  
+  # To instantiate a resource for update without fetching it first, set an id
+  location = FrederickAPI::V2::Location.new(id: location_id)
+  location.update_attributes(phone_number: '(555) 555-5555')
+  # => true
+end
+```

data/lib/frederick_api/configuration.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module FrederickAPI # :nodoc:
+  class << self
+    attr_writer :config
+  end
+
+  # You may use `FrederickAPI.configure` to configure the Frederick
+  # Internal API Gem or you can use environment variables. By default, the
+  # client will connect to staging with a blank API key.
+  # @see .configure
+  class Configuration
+    DEFAULTS = {
+      base_url: ENV['FREDERICK_API_BASE_URL'] ||
+        'https://api.staging.hirefrederick.com',
+      api_key: ENV['FREDERICK_API_KEY']
+    }.freeze
+
+    attr_accessor :base_url, :api_key
+
+    def initialize
+      @base_url = DEFAULTS[:base_url]
+      @api_key = DEFAULTS[:api_key]
+    end
+  end
+
+  # Configure FrederickAPI, for example in an initializer or (better
+  # yet) in one of the `config/environments/*.rb` files so you can have it
+  # configured differently per environment. For example, you may want to use
+  # staging API in staging environment, or may want different timeouts in
+  # development environment than production.
+  #
+  # @example
+  #   # config/environments/staging.rb
+  #   ...
+  #   FrederickAPI.configure do |c|
+  #     c.base_url = 'https://api.staging.hirefrederick.com/v1'
+  #     c.api_key = '1234-5678-1234-5678-1234-5678'
+  #   end
+  #   ...
+  #
+  # @yield [configuration] block to configure FrederickAPI
+  # @return [FrederickAPI::Configuration] the completed configuration
+  def self.configure
+    yield(config)
+  end
+
+  # Returns a reference to the current configuration.
+  #
+  # @return [FrederickAPI::Configuration]
+  def self.config
+    @config ||= Configuration.new
+  end
+end

data/lib/frederick_api/v2/location.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    class Location < Resource
+    end
+  end
+end

data/lib/frederick_api/v2/query_builder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module'
+
+module FrederickAPI
+  module V2
+    # Used to convert nested params to dot notation for Frederick API
+    class QueryBuilder < JsonApiClient::Query::Builder
+      def params
+        to_dot_params(
+          filter_params.merge(pagination_params.merge(includes_params).merge(select_params))
+        ).merge(order_params)
+          .merge(primary_key_params)
+          .merge(path_params)
+          .merge(additional_params)
+      end
+
+      def to_dot_params(object, prefix = nil)
+        return {} if object == {}
+
+        if object.is_a? Hash
+          object.map do |key, value|
+            if prefix
+              to_dot_params value, "#{prefix}.#{key}"
+            else
+              to_dot_params value, key.to_s
+            end
+          end.reduce(&:merge)
+        else
+          { prefix => object }
+        end
+      end
+    end
+  end
+end

data/lib/frederick_api/v2/resource.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # Class from which Frederick V2 Resources inherit
+    # Inherits functionality from JsonApiClient::Resource
+    class Resource < JsonApiClient::Resource
+      self.query_builder = FrederickAPI::V2::QueryBuilder
+
+      def self.site
+        "#{FrederickAPI.config.base_url}/v2/"
+      end
+
+      def self.with_access_token(token)
+        with_headers(authorization: "Bearer #{token}") do
+          yield
+        end
+      end
+
+      def self.custom_headers
+        super.merge(x_api_key: FrederickAPI.config.api_key)
+      end
+    end
+  end
+end

data/lib/frederick_api/v2/user.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    class User < Resource
+    end
+  end
+end

data/lib/frederick_api/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  # Current gem version
+  VERSION = '0.1.0'
+end

data/lib/frederick_api.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Third-party libs
+require 'json_api_client'
+
+# FrederickAPI libs
+require 'frederick_api/configuration'
+require 'frederick_api/v2/query_builder'
+require 'frederick_api/v2/resource'
+
+require 'frederick_api/v2/user'
+require 'frederick_api/v2/location'
+
+# Namespace for all Frederick API client methods/classes
+module FrederickAPI
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: frederick_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frederick Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: Ruby client for the Frederick API
+email:
+- tech@hirefrederick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/frederick_api.rb
+- lib/frederick_api/configuration.rb
+- lib/frederick_api/v2/location.rb
+- lib/frederick_api/v2/query_builder.rb
+- lib/frederick_api/v2/resource.rb
+- lib/frederick_api/v2/user.rb
+- lib/frederick_api/version.rb
+homepage: https://github.com/HireFrederick/frederick_api_gem
+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.11
+signing_key: 
+specification_version: 4
+summary: Frederick API Client
+test_files: []