relink_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6b94dada4335f7ba75870ce8e662dfcb937284d
+  data.tar.gz: f4d26df2d27e6d20c12933fae8ab783bc88c7044
+SHA512:
+  metadata.gz: dd84b803424d6a3032d305fa2ac93ee01be84160e5638accd420bc11502249b362f38d24f32eb97ecbc31463136782b65d3e90c3b9bef00df00ec1da78e6e736
+  data.tar.gz: a7bb139bcc655abf720fdc641f224df3da13bc251eee8e07ceffe35db1821421abd9843d786b6d435fb81b72fd4e1aa4196e5e17ba1e3752a00e4b1820a9b5ac

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in relink_marlowe_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andriy Lukashchuk
+
+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,41 @@
+# RelinkMarloweApi
+
+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/relink_marlowe_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 'relink_marlowe_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relink_marlowe_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]/relink_marlowe_api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "relink_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
+
+require "irb"
+IRB.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/extensions/hash.rb

@@ -0,0 +1,19 @@
+class Hash
+
+  def deep_stringify_keys
+    inject({}) do |hash, (key, value)|
+      value = value.stringify_keys if value.is_a?(Hash)
+      hash[key.to_s] = value
+      hash
+    end
+  end
+
+  def deep_camelize_keys
+    inject({}) do |hash, (key, value)|
+      value = value.is_a?(Hash) ? value.deep_camelize_keys : value
+      hash[key.to_s.camelizify] = value
+      hash
+    end
+  end
+
+end

data/lib/extensions/string.rb

@@ -0,0 +1,10 @@
+class String
+
+  def camelizify(lower=true)
+    self.split('_').map.with_index do |val, index|
+      val = val.capitalize if index > 0 && lower
+      val
+    end.join
+  end
+
+end

data/lib/relink_api.rb

@@ -0,0 +1,61 @@
+require "extensions/string"
+require "extensions/hash"
+
+require "relink_api/version"
+require "relink_api/configuration"
+require "relink_api/client"
+require "relink_api/jobs"
+require "relink_api/social"
+require "relink_api/analyze"
+require "relink_api/exceptions"
+
+module RelinkApi
+
+  def self.authenticate
+    raise MissingAPICredentials unless self.config
+                                       self.config.api_key    &&
+                                       self.config.api_secret &&
+                                       self.config.account_id
+
+    self.client.authenticate
+  end
+
+  def self.authentication_header
+    raise NotAuthorized         unless client.token
+
+    { "Authorization" => "Bearer #{client.token}",
+      "Content-Type"  => "application/json",
+      "Accept"        => "application/json" }
+  end
+
+  def self.client
+    @client ||= Client.new
+    @client
+  end
+
+  protected
+
+  def self.check_params_presence(present:, required:)
+    required.each do |key|
+      raise "#{key} key missing" unless present.has_key?(key)
+    end
+  end
+
+  def self.camelize_params(params)
+    new_params = {}
+
+    params.each do |key, value|
+      new_value = value.is_a?(Hash) ? camelize_params(value) : value
+      new_params[key.to_s.camelizify] = new_value
+    end
+
+    new_params
+  end
+
+  def self.transform_params(params)
+    params.merge({"accountId": RelinkApi.config.account_id})
+          .deep_stringify_keys
+          .deep_camelize_keys
+  end
+
+end

data/lib/relink_api/analyze.rb

@@ -0,0 +1,29 @@
+# Methods for working with AnAlyze
+# API docs: https://docs.relinklabs.com/marlowe/#Analyze
+require 'httparty'
+
+module RelinkApi
+  module Analyze
+
+    CREATE_REQUIRED_PARAMS         = %w(jobId profile)
+    CREATE_PROFILE_REQUIRED_PARAMS = %w(name summary positions
+                                      email skills educations)
+
+    CREATE_URL             = "/analyze".freeze
+
+    def self.create(params = {})
+      params = RelinkApi.transform_params(params)
+
+      RelinkApi.check_params_presence(present:  params,
+                                      required: CREATE_REQUIRED_PARAMS)
+
+      RelinkApi.check_params_presence(present:  params['profile'],
+                                      required: CREATE_PROFILE_REQUIRED_PARAMS)
+
+      HTTParty.post(RelinkApi.config.api_base_url + CREATE_URL,
+                    body:    params.to_json,
+                    headers: RelinkApi.authentication_header)
+    end
+
+  end
+end

data/lib/relink_api/client.rb

@@ -0,0 +1,37 @@
+require "base64"
+require "httparty"
+
+module RelinkApi
+
+  class Client
+
+    attr_reader :token
+
+    def authenticate
+      raise MissingAPICredentials unless RelinkApi.config.api_key &&
+                                         RelinkApi.config.api_secret
+
+      response = HTTParty.get(RelinkApi.config.api_base_url + "/token",
+                         headers: authentication_header)
+
+      if response.code == 200
+        body = JSON.parse(response.body)
+        @token = body['token']
+      else
+        raise AuthenticationError
+      end
+
+    end
+
+    private
+
+      def authentication_header
+        plain_string = RelinkApi.config.api_key + ':' +
+                       RelinkApi.config.api_secret
+        b64_string   = Base64.strict_encode64(plain_string)
+
+        {"Authorization" => "Basic #{b64_string}"}
+      end
+  end
+
+end

data/lib/relink_api/configuration.rb

@@ -0,0 +1,26 @@
+module RelinkApi
+
+  API_BASE_URL = "http://marlowe.relinklabs.com".freeze
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_secret
+    attr_accessor :api_base_url
+    attr_accessor :notification_url
+    attr_accessor :account_id
+
+    def initialize
+      @api_base_url = API_BASE_URL
+    end
+  end
+
+end

data/lib/relink_api/exceptions.rb

@@ -0,0 +1,15 @@
+module RelinkApi
+
+  class MissingAPICredentials < StandardError
+  end
+
+  class AuthenticationError < StandardError
+  end
+
+  class NotAuthorized < StandardError
+  end
+
+  class MissingParams < StandardError
+  end
+
+end

data/lib/relink_api/jobs.rb

@@ -0,0 +1,53 @@
+# Methods for working with Jobs
+# API docs: https://docs.relinklabs.com/marlowe/#Jobs
+require 'httparty'
+
+module RelinkApi
+  module Jobs
+
+    CREATE_REQUIRED_PARAMS = %w(accountId companyName companyUrl
+                                title description location)
+    CREATE_LOCATION_PARAMS = %w(name cc coords)
+    CREATE_COORDS_PARAMS   = %w(lat lon)
+
+    CREATE_URL = "/jobs"
+    INDEX_URL  = "/jobs"
+    SHOW_URL   = "/jobs/"
+    DELETE_URL = "/jobs/"
+
+    def self.create(params = {})
+      params = RelinkApi.transform_params(params)
+
+      RelinkApi.check_params_presence(present:  params,
+                                      required: CREATE_REQUIRED_PARAMS)
+      RelinkApi.check_params_presence(present:  params["location"],
+                                      required: CREATE_LOCATION_PARAMS)
+      RelinkApi.check_params_presence(present:  params["location"]["coords"],
+                                      required: CREATE_COORDS_PARAMS)
+
+
+      HTTParty.post(RelinkApi.config.api_base_url + CREATE_URL,
+                    body:    params.to_json,
+                    headers: RelinkApi.authentication_header)
+    end
+
+    def self.index(params = {})
+      params = RelinkApi.transform_params(params)
+
+      HTTParty.get(RelinkApi.config.api_base_url + INDEX_URL,
+                   query: params,
+                   headers: RelinkApi.authentication_header)
+     end
+
+    def self.show(id)
+      HTTParty.get(RelinkApi.config.api_base_url + SHOW_URL + id,
+                   headers: RelinkApi.authentication_header)
+    end
+
+    def self.delete(id)
+      HTTParty.get(RelinkApi.config.api_base_url + DELETE_URL + id,
+                   headers: RelinkApi.authentication_header)
+    end
+
+  end
+end

data/lib/relink_api/social.rb

@@ -0,0 +1,16 @@
+# Methods for working with Social
+# API docs: https://docs.relinklabs.com/marlowe/#Social
+require 'httparty'
+
+module RelinkApi
+  module Social
+
+    GET_URL    = "/social".freeze
+
+    def self.show(email:)
+      HTTParty.get(RelinkApi.config.api_base_url + GET_URL + "?email=" + email,
+                   headers: RelinkApi.authentication_header)
+    end
+
+  end
+end

data/lib/relink_api/version.rb

@@ -0,0 +1,3 @@
+module RelinkApi
+  VERSION = "0.1.0"
+end

data/relink_marlowe_api.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relink_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "relink_api"
+  spec.version       = RelinkApi::VERSION
+  spec.authors       = ["Andriy Lukashchuk"]
+  spec.email         = ["darksundarksun@gmail.com"]
+
+  spec.summary       = %q{Relink Marlowe API wrapper.}
+  spec.description   = %q{Relink Marlowe API wrapper https://relinklabs.com.}
+  spec.homepage      = "https://github.com/Dark-Sun/relink_api"
+  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_runtime_dependency 'httparty', '~> 0.13.7'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", '~> 0'
+  spec.add_development_dependency "factory_girl", '~> 0'
+  spec.add_development_dependency "faker", '~> 0'
+  spec.add_development_dependency "pry", '~> 0'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: relink_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andriy Lukashchuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: faker
+  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: Relink Marlowe API wrapper https://relinklabs.com.
+email:
+- darksundarksun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/extensions/hash.rb
+- lib/extensions/string.rb
+- lib/relink_api.rb
+- lib/relink_api/analyze.rb
+- lib/relink_api/client.rb
+- lib/relink_api/configuration.rb
+- lib/relink_api/exceptions.rb
+- lib/relink_api/jobs.rb
+- lib/relink_api/social.rb
+- lib/relink_api/version.rb
+- relink_marlowe_api.gemspec
+homepage: https://github.com/Dark-Sun/relink_api
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Relink Marlowe API wrapper.
+test_files: []