hubble_observatory 1.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a1f79fe1250bd92727ec3c05039b0de394b5a8d
+  data.tar.gz: 0b100bb0b20e83bf09d8152c1be1d8d34d0acafe
+SHA512:
+  metadata.gz: 7d51fdd664d111a922c1f63e3743a2589ccf678cd4a78427f85f1d131cee6660f87d2a28b0d35f4bdc87df820e24fb84336097610a1760f67b973749ccc8a181
+  data.tar.gz: 7cc8f952d390910f064c2365099a142a80f39507b36d6b8e7c5434eee50709dcdf2543a216e9efbef4a8f26dce4dd8819019e18751342bc9a4a604ee84f9aa9f

data/.env.example

@@ -0,0 +1,2 @@
+export HUBBLE_APP_TOKEN=zzz
+export HUBBLE_ENV=staging

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install:
+  - gem install bundler -v 1.14.6
+script:
+  - bundle exec rspec
+  - bundle exec yard stats | grep "100.00% documented"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Fullscreen, Inc
+
+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,83 @@
+Hubble Observatory
+==================
+
+Hubble Observatory is a Ruby library to interact with the Hubble API.
+
+The **source code** is available on [GitHub](https://github.com/fullscreen/hubble_observatory) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/hubble_observatory/frames).
+
+[![Build Status](http://img.shields.io/travis/Fullscreen/hubble_observatory/master.svg)](https://travis-ci.org/Fullscreen/hubble_observatory)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/hubble_observatory/master.svg)](https://coveralls.io/r/Fullscreen/hubble_observatory)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/hubble_observatory.svg)](https://gemnasium.com/Fullscreen/hubble_observatory)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/hubble_observatory.svg)](https://codeclimate.com/github/Fullscreen/hubble_observatory)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/hubble_observatory/frames)
+[![Gem Version](http://img.shields.io/gem/v/hubble_observatory.svg)](http://rubygems.org/gems/hubble_observatory)
+
+After [registering your app](https://fullscreen.github.io/hubble_observatory/), you can run commands like:
+
+```ruby
+HubbleObservatory::TalentAccount.create email: 'user@example.com'
+# => '123456'
+```
+
+The **full documentation** is available at [rubydoc.info](http://www.rubydoc.info/gems/hubble_observatory/frames).
+
+
+## Installation and Configuration
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'hubble_observatory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hubble_observatory
+
+Set the following ENV variables in your Ruby/Rails application
+
+```ruby
+ENV['HUBBLE_APP_TOKEN'] = "<app token to access Hubble API>"
+ENV['HUBBLE_ENV'] = "production"
+```
+
+If you don’t set `ENV['HUBBLE_ENV']` to "production", the staging Hubble API will be targeted.
+
+## How to use
+
+Hubble Observatory provide only two methods to create and update talent accounts.
+
+### TalentAccount.create
+
+Obtain the ID of Talent Account given the corresponding email:
+
+```ruby
+talent_account = HubbleObservatory::TalentAccount.create email: 'user@example.com'
+# => '123456'
+```
+
+### TalentAccount#update
+
+Update the email of a Talent Account give the corresponding ID:
+
+```ruby
+talent_account = HubbleObservatory::TalentAccount.new id: '123456'
+talent_account.update email: 'newuser@example.com'
+# => '123456'
+```
+
+## How to develop and contribute
+
+To install the app and its dependencies, run `bin/setup`.
+
+To execute the test suite, run:
+
+```ruby
+HUBBLE_APP_TOKEN=<token> bundle exec rake
+```
+
+To release a new version, run: `bundle exec rake release`.

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 "hubble_api_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/hubble_observatory.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hubble_observatory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hubble_observatory"
+  spec.version       = HubbleObservatory::VERSION
+  spec.authors       = ["Bruce Park"]
+  spec.email         = ["bruce.park@fullscreen.net"]
+
+  spec.summary       = %q{A client gem for the Hubble API}
+  spec.description   = %q{A client gem for the Hubble API}
+  spec.homepage      = "https://github.com/Fullscreen/hubble_observatory"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.1.2'
+
+  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_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.21'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'yard', '~> 0.9.9'
+end

data/lib/hubble_observatory.rb

@@ -0,0 +1,5 @@
+require "net/http"
+require "json"
+require "openssl"
+require "hubble_observatory/talent_account"
+require "hubble_observatory/errors"

data/lib/hubble_observatory/errors.rb

@@ -0,0 +1,18 @@
+# An object-oriented client for the Hubble API
+module HubbleObservatory
+  # Documents the connection errors that can occur
+  class ConnectionError < StandardError
+    # Possible list of connection errors that can occur
+    def self.errors
+      [
+        OpenSSL::SSL::SSLError,
+        Errno::ETIMEDOUT,
+        Errno::EHOSTUNREACH,
+        Errno::ENETUNREACH,
+        Errno::ECONNRESET,
+        Net::OpenTimeout,
+        SocketError
+      ]
+    end
+  end
+end

data/lib/hubble_observatory/talent_account.rb

@@ -0,0 +1,84 @@
+module HubbleObservatory
+  # Provides methods to interact with the Hubble API talent-accounts endpoint
+  # @see https://hubble.fullscreen.net/api/docs#talentaccounts-create-talent-account
+  class TalentAccount
+
+    def initialize(id:)
+      @hubble_uuid = id
+    end
+
+    # @return [String] the hubble uuid associated with the email
+    def self.create(email:)
+      data = parse process_request(route: "talent-accounts", body_attrs: {email: email}, request_type: "post")
+      process_account_data(data)
+    end
+
+    # @return [String] the hubble uuid associated with the email
+    def update(email:)
+      data = self.class.parse self.class.process_request(route: "talent-accounts/#{@hubble_uuid}", body_attrs: {email: email}, request_type: "put")
+      self.class.process_account_data(data)
+    end
+
+    private
+
+    def self.serialize_attributes(attributes:)
+      {
+        data: {
+          type: "talent-accounts",
+          attributes: attributes
+        }
+      }
+    end
+
+    def self.parse(response)
+      data_response = JSON.parse response.body, symbolize_names: true
+    end
+
+    def self.process_account_data(account_data)
+      extract_attribute_from_data(data: account_data, attribute: :id) || extract_uuid_from_errors(data: account_data)
+    end
+
+    def self.extract_attribute_from_data(data:, attribute:)
+      data.fetch(:data, {}).fetch(attribute, nil)
+    end
+
+    def self.extract_uuid_from_errors(data:)
+      data.fetch(:errors, [{}])[0].fetch(:hubble_uuid, nil)
+    end
+
+    def self.process_request(route:, body_attrs:, request_type:)
+      uri = URI::HTTPS.build host: host,
+        path: "/api/v1/#{route}"
+      net_http_class = Object.const_get("Net::HTTP::#{request_type.capitalize}")
+      body = serialize_attributes(attributes: body_attrs)
+      request = net_http_class.new uri
+      request.body = body.to_json
+      response_for(assign_headers(request), uri)
+    end
+
+    def self.response_for(http_request, uri)
+      Net::HTTP.start(uri.host, 443, use_ssl: true) do |http|
+        http.request http_request
+      end
+    rescue *ConnectionError.errors => e
+      raise ConnectionError, e.message
+    end
+
+    def self.assign_headers(request)
+      headers.each_key do |header|
+        request[header] = headers[header]
+      end
+      request
+    end
+
+    def self.host
+      subdomain = ENV['HUBBLE_ENV'] == 'production' ? 'hubble' : 'rc-hubble'
+      "#{subdomain}.fullscreen.net"
+    end
+
+    def self.headers
+      {"Authorization" => "Bearer #{ENV['HUBBLE_APP_TOKEN']}",
+       "Content-Type" => "application/vnd.api+json"}
+    end
+  end
+end

data/lib/hubble_observatory/version.rb

@@ -0,0 +1,4 @@
+module HubbleObservatory
+  # current version of gem
+  VERSION = '1.0.0.alpha'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: hubble_observatory
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha
+platform: ruby
+authors:
+- Bruce Park
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+description: A client gem for the Hubble API
+email:
+- bruce.park@fullscreen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hubble_observatory.gemspec
+- lib/hubble_observatory.rb
+- lib/hubble_observatory/errors.rb
+- lib/hubble_observatory/talent_account.rb
+- lib/hubble_observatory/version.rb
+homepage: https://github.com/Fullscreen/hubble_observatory
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A client gem for the Hubble API
+test_files: []