cloudsight 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 88263f76dbd9b938a6196193e5f9d2695ad28c29
-  data.tar.gz: 195421c20284a46e5e8967026958f8a779a4e377
+SHA256:
+  metadata.gz: 8b27c9ad341947fd8365b93eeca9202c44bc6997cc153171e45528e0a4f7553e
+  data.tar.gz: c4a7a7de5c7b9704925edbab211097e675802937ea3d71070ddd10624c54dfe9
 SHA512:
-  metadata.gz: a0526368cef6a2cd9c8cfdb4b4c3f9ae99f1e7628198b051bce03dcbe1db6dbedc0570c606861bc7886983760310f362152fe77a07e77595c09c31e160b238f5
-  data.tar.gz: 5f841aa7c29d5da09d398119a1af5402d780b3362b348dd6433ea5e2a47849812ec6c1ae1ee83f5e29e849ef9c23274abf8121510fbc985fb0baa9b88de462ad
+  metadata.gz: 575f5503cee38dfd89d8f58cae1a04ee9ba994d6b0dd03f7ebdf9ee917e8c3923a40c66ffd4ceb7b6221dc4cef6bf4cc5645c14d0f2c5efab8011454418d1ed5
+  data.tar.gz: 439fb02ed6c5164ca146d76150832729c348260337b918205bcb753fa1220aa0fbc3f9ed9652baf596f2fc35918caf5ab1d966215d7d88078b6af7507a87ad41

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rspec_status
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+cache: bundler
+
+script:
+  - bundle exec rspec
+
+branches:
+  only:
+    - master
+
+before_install:
+  - gem update --system
+  - gem update bundler
+
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0

data/README.md

@@ -5,8 +5,8 @@ A simple CloudSight API Client
 
 | Project                 |  Gem Release      |
 |------------------------ | ----------------- |
-| gem name                |  gem-release      |
-| version                 |  [![Gem Version](https://badge.fury.io/rb/gem-release.png)](http://badge.fury.io/rb/gem-release) |
+| gem name                |  cloudsight       |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/cloudsight.svg)](https://badge.fury.io/rb/cloudsight)
 | continuous integration  |  [![Build Status](https://secure.travis-ci.org/cloudsight/cloudsight-ruby.png?branch=master)](https://travis-ci.org/cloudsight/cloudsight-ruby) |
 
 Installation
@@ -51,25 +51,25 @@ Usage
 Send the image request using a file:
 
 ```ruby
-requestData = Cloudsight::Request.send(locale: 'en', file: File.open('image.jpg'))
+request_data = Cloudsight::Request.send(locale: 'en', file: File.open('image.jpg'))
 ```
 
 Or, you can send the image request using a URL:
 
 ```ruby
-requestData = Cloudsight::Request.send(locale: 'en', url: 'http://www.google.com/images/srpr/logo11w.png')
+request_data = Cloudsight::Request.send(locale: 'en', url: 'http://www.google.com/images/srpr/logo11w.png')
 ```
 
 Then, use the token to retrieve the response:
 
 ```ruby
-responseData = Cloudsight::Response.get(requestData['token'])
+response_data = Cloudsight::Response.get(request_data['token'])
 ```
 
 You can also use the `retrieve` method which will poll for the response for you:
 
 ```ruby
-Cloudsight::Response.retrieve(requestData['token']) do |responseData|
-  p responseData
+Cloudsight::Response.retrieve(request_data['token']) do |response_data|
+  p response_data
 end
 ```

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.fail_on_error = false
+  end
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloudsight"
+require "pry"
+
+Pry.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/cloudsight.gemspec

@@ -6,30 +6,29 @@ require 'cloudsight/version'
 Gem::Specification.new do |s|
   s.name        = 'cloudsight'
   s.version     = Cloudsight::VERSION
-  s.date        = '2015-11-05'
   s.summary     = "CloudSight API Client"
   s.description = "A simple CloudSight API Client for Image Recognition"
-  s.authors     = ['Brad Folkens']
-  s.email       = 'brad@cloudsightapi.com'
+  s.authors     = ['Brad Folkens', 'Jack McCallum', 'Chris Weilemann']
+  s.email       = 'oss@cloudsight.ai'
   s.homepage    = 'http://github.com/cloudsight/cloudsight-ruby'
   s.license			= 'MIT'
   s.platform    = Gem::Platform::RUBY
 
-  s.files       = [
-    'lib/cloudsight.rb',
-    'Gemfile',
-    'Gemfile.lock',
-    'MIT-LICENSE',
-    'README.md',
-    'cloudsight.gemspec'
-  ]
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
   s.require_paths = [%q{lib}]
 
-  s.required_ruby_version = Gem::Requirement.new('>= 1.9.1')
+  s.required_ruby_version = Gem::Requirement.new('>= 2.1')
 
-  s.add_dependency 'json'
-  s.add_dependency 'rest-client', '~>1.6'
+  s.add_dependency 'json', '~> 2.1'
+  s.add_dependency 'rest-client', '~> 2.0'
 
-  s.add_development_dependency 'bundler', '~> 1.6'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'webmock', '~> 3.0'
+  s.add_development_dependency 'simple_oauth', '~> 0.3'
 end

data/lib/cloudsight.rb

@@ -1,139 +1,37 @@
 require 'rubygems'
 require 'rest-client'
 begin
-	require 'simple_oauth'
-rescue LoadError => err
-	# Tolerate not having this unless it's actually configured
+  require 'simple_oauth'
+rescue LoadError
+  # Tolerate not having this unless it's actually configured
 end
 require 'json'
 
 module Cloudsight
-	BASE_URL = 'https://api.cloudsight.ai'
+  BASE_URL = 'https://api.cloudsight.ai'
 
-	class << self
-		def oauth_options=(val)
-			raise RuntimeError.new("Could not load the simple_oauth gem. Install it with `gem install simple_oauth`.") unless defined?(SimpleOAuth::Header)
+  class << self
+    FIELDS = %w(api_key oauth_options base_url)
+    attr_accessor(*FIELDS)
 
-			val = val.inject({}) {|memo, (k, v)| memo[k.to_sym] = v; memo }
-			@@oauth_options = val
-		end
+    def oauth_options=(val)
+      raise RuntimeError.new(
+        "Could not load the simple_oauth gem. Install it with `gem install simple_oauth`."
+      ) unless defined?(SimpleOAuth::Header)
 
-		def api_key=(val)
-			@@api_key = val
-			RestClient.add_before_execution_proc do |req, params|
-				req.add_field 'Authorization', "CloudSight #{val}"
-			end
-		end
+      val = val.inject({}) {|memo, (k, v)| memo[k.to_sym] = v; memo }
+      @oauth_options = val
+    end
 
-		def api_key
-			@@api_key if defined?(@@api_key)
-		end
+    def base_url
+      @base_url ||= BASE_URL
+    end
+  end
 
-		def oauth_options
-			@@oauth_options if defined?(@@oauth_options)
-		end
+  require 'cloudsight/api'
+  require 'cloudsight/request'
+  require 'cloudsight/response'
 
-		def base_url=(val)
-			@@base_url = val
-		end
-
-		def base_url
-			@@base_url ||= BASE_URL
-		end
-	end
-
-	class Util
-		def self.wrap_request &block
-			RestClient.reset_before_execution_procs
-			RestClient.add_before_execution_proc do |req, params|
-				if params[:payload]
-					filtered_payload = params[:payload].dup
-					filtered_payload.delete('image_request[image]')
-				end
-
-				oauth = SimpleOAuth::Header.new(params[:method], params[:url], filtered_payload, Cloudsight.oauth_options || {})
-			  req.add_field 'Authorization', oauth.to_s
-			end
-
-			begin
-				retval = yield
-			rescue RestClient::Exception => e
-				retval = e.response
-			end
-
-			RestClient.reset_before_execution_procs
-
-			return retval
-		end
-	end
-
-	class Request
-		def self.send(options = {})
-			raise RuntimeError.new("Need to define either oauth_options or api_key") unless Cloudsight.api_key || Cloudsight.oauth_options
-			url = "#{Cloudsight::base_url}/image_requests"
-
-			params = {}
-			[:locale, :language, :latitude, :longitude, :altitude, :device_id, :ttl].each do |attr|
-				params["image_request[#{attr}]"] = options[attr] if options.has_key?(attr)
-			end
-
-			if options[:focus]
-				params['focus[x]'] = options[:focus][:x]
-				params['focus[y]'] = options[:focus][:y]
-			end
-
-			params['image_request[remote_image_url]'] = options[:url] if options.has_key?(:url)
-			params['image_request[image]'] = options[:file] if options.has_key?(:file)
-
-			response = Util.wrap_request { RestClient.post(url, params) }
-			data = JSON.parse(response.body)
-			raise ResponseException.new(data['error']) if data['error']
-			raise UnexpectedResponseException.new(response.body) unless data['token']
-			
-			data
-		end
-
-		def self.repost(token, options = {})
-			url = "#{Cloudsight::base_url}/image_requests/#{token}/repost"
-
-			response = Util.wrap_request { RestClient.post(url, options) }
-			return true if response.code == 200 and response.body.to_s.strip.empty?
-
-			data = JSON.parse(response.body)
-			raise ResponseException.new(data['error']) if data['error']
-			raise UnexpectedResponseException.new(response.body) unless data['token']
-
-			data
-		end
-	end
-
-	class Response
-		def self.get(token, options = {})
-			url = "#{Cloudsight::base_url}/image_responses/#{token}"
-
-			response = Util.wrap_request { RestClient.get(url) }
-			data = JSON.parse(response.body)
-			raise ResponseException.new(data['error']) if data['error']
-			raise UnexpectedResponseException.new(response.body) unless data['status']
-
-			data
-		end
-
-		def self.retrieve(token, options = {})
-			options = { poll_wait: 1 }.merge(options)
-
-			data = nil
-			loop do
-				sleep options[:poll_wait]
-				data = Cloudsight::Response.get(token, options)
-				yield data if block_given?
-				break if data['status'] != 'not completed' and data['status'] != 'in progress'
-			end
-
-			data
-		end
-	end
-
-	class ResponseException < Exception; end
-	class UnexpectedResponseException < Exception; end
+  class ResponseException < Exception; end
+  class UnexpectedResponseException < Exception; end
 end

data/lib/cloudsight/api.rb

@@ -0,0 +1,32 @@
+module Cloudsight
+  class Api
+    class << self
+      def post(url, params, headers = {})
+        headers['Authorization'] = authorization_header(:post, url, params)
+        RestClient.post(url, params, headers)
+      rescue RestClient::Exception => e
+        e.response
+      end
+
+      def get(url, headers = {})
+        headers['Authorization'] = authorization_header(:get, url)
+        RestClient.get(url, headers)
+      rescue RestClient::Exception => e
+        e.response
+      end
+
+      def authorization_header(http_method, url, params = {})
+        if Cloudsight.api_key
+          "CloudSight #{Cloudsight.api_key}"
+        else
+          # Exclude image file when generating OAuth header
+          filtered_payload = params.dup
+          filtered_payload.delete('image_request[image]')
+
+          oauth = SimpleOAuth::Header.new(http_method, url, filtered_payload, Cloudsight.oauth_options || {})
+          oauth.to_s
+        end
+      end
+    end
+  end
+end

data/lib/cloudsight/request.rb

@@ -0,0 +1,53 @@
+module Cloudsight
+  class Request
+    class << self
+      def send(options = {})
+        raise RuntimeError.new("Need to define either oauth_options or api_key") unless Cloudsight.api_key || Cloudsight.oauth_options
+        url = "#{Cloudsight::base_url}/v1/images"
+
+        params = construct_params(options)
+        response = Api.post(url, params)
+        data = JSON.parse(response.body)
+        raise ResponseException.new(data['error']) if data['error']
+        raise UnexpectedResponseException.new(response.body) unless data['token']
+
+        data
+
+      rescue JSON::ParserError
+        raise UnexpectedResponseException.new(response.body)
+      end
+
+      def repost(token, options = {})
+        url = "#{Cloudsight::base_url}/v1/images/#{token}/repost"
+
+        response = Api.post(url, options)
+        return true if response.code == 200 and response.body.to_s.strip.empty?
+
+        data = JSON.parse(response.body)
+        raise ResponseException.new(data['error']) if data['error']
+        raise UnexpectedResponseException.new(response.body) unless data['token']
+
+        data
+
+      rescue JSON::ParserError
+        raise UnexpectedResponseException.new(response.body)
+      end
+
+      def construct_params(options)
+        params = {}
+        [:locale, :language, :latitude, :longitude, :altitude, :device_id, :ttl, :focus_x, :focus_y].each do |attr|
+          params[attr.to_s] = options[attr] if options.has_key?(attr)
+        end
+
+        if options[:focus]
+          params['focus_x'] = options[:focus][:x]
+          params['focus_y'] = options[:focus][:y]
+        end
+
+        params['remote_image_url'] = options[:url] if options.has_key?(:url)
+        params['image'] = options[:file] if options.has_key?(:file)
+        params
+      end
+    end
+  end
+end

data/lib/cloudsight/response.rb

@@ -0,0 +1,33 @@
+module Cloudsight
+  class Response
+    class << self
+      def get(token, options = {})
+        url = "#{Cloudsight::base_url}/v1/images/#{token}"
+
+        response = Api.get(url)
+        data = JSON.parse(response.body)
+        raise ResponseException.new(data['error']) if data['error']
+        raise UnexpectedResponseException.new(response.body) unless data['status']
+
+        data
+
+      rescue JSON::ParserError
+        raise UnexpectedResponseException.new(response.body)
+      end
+
+      def retrieve(token, options = {})
+        options = { poll_wait: 1 }.merge(options)
+
+        data = nil
+        loop do
+          sleep options[:poll_wait]
+          data = Cloudsight::Response.get(token, options)
+          yield data if block_given?
+          break if data['status'] != 'not completed' and data['status'] != 'in progress'
+        end
+
+        data
+      end
+    end
+  end
+end

data/lib/cloudsight/version.rb

@@ -0,0 +1,3 @@
+module Cloudsight
+  VERSION = "0.1.1"
+end

data/spec/cloudsight/api_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'simple_oauth'
+
+RSpec.describe Cloudsight::Api do
+
+  describe '#authorization_header' do
+    context 'with an api_key' do
+      it 'returns the proper header' do
+        Cloudsight.api_key = 'test_api_key'
+        header = described_class.authorization_header(:get, 'test')
+        expect(header).to eq 'CloudSight test_api_key'
+      end
+    end
+
+    context 'with simple oauth' do
+      it 'returns the proper header' do
+        Cloudsight.oauth_options = {
+          consumer_key: 'test_consumer_key',
+          consumer_secret: 'test_consumer_secret'
+        }
+
+        header = described_class.authorization_header(:get, 'https://example.com', { image_request: {} })
+        expect(header).to match(/OAuth oauth_consumer_key=/)
+      end
+    end
+  end
+
+  describe '#post' do
+    let(:url) { 'https://example.com' }
+
+    it 'should post with the correct params' do
+      allow(described_class).to receive(:authorization_header).and_return("CloudSight test_api_key")
+
+      expect(RestClient).to receive(:post).with(
+        url, {}, {"Authorization"=>"CloudSight test_api_key"}
+      )
+
+      described_class.post(url, {})
+    end
+
+    it 'should return the response if there is one' do
+      allow(described_class).to receive(:authorization_header).and_return("CloudSight test_api_key")
+
+      allow(RestClient).to receive(:post).with(
+        url, {}, {"Authorization"=>"CloudSight test_api_key"}
+      ).and_raise(RestClient::Exception)
+
+      expect { described_class.post(url, {}) }.to_not raise_error
+    end
+  end
+
+  describe '#get' do
+    let(:url) { 'https://example.com' }
+
+    it 'should post with the correct params' do
+      allow(described_class).to receive(:authorization_header).and_return("CloudSight test_api_key")
+
+      expect(RestClient).to receive(:get).with(
+        url, {"Authorization"=>"CloudSight test_api_key"}
+      )
+
+      described_class.get(url, {})
+    end
+
+    it 'should return the response if there is one' do
+      allow(described_class).to receive(:authorization_header).and_return("CloudSight test_api_key")
+
+      allow(RestClient).to receive(:get).with(
+        url, {"Authorization"=>"CloudSight test_api_key"}
+      ).and_raise(RestClient::Exception)
+
+      expect { described_class.get(url, {}) }.to_not raise_error
+    end
+  end
+end

data/spec/cloudsight/request_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+RSpec.describe Cloudsight::Request do
+
+  before(:each) do
+    Cloudsight.api_key = 'test_api_key'
+  end
+
+  describe '#construct_params' do
+    let(:params) do
+      {
+        locale: 'en',
+        language: 'en',
+        latitude: '5',
+        longitude: '5',
+        altitude: '5',
+        device_id: '5',
+        ttl: '5',
+        url: 'test_url',
+        file: 'test_file',
+        focus: {
+          x: '5',
+          y: '5'
+        }
+      }
+    end
+
+    it 'correctly constructs the params' do
+      options = described_class.construct_params(params)
+      expect(options).to eq(
+        {
+          'locale' => 'en',
+          'language' => 'en',
+          'latitude' => '5',
+          'longitude' => '5',
+          'altitude' => '5',
+          'device_id' => '5',
+          'ttl' => '5',
+          'remote_image_url' => 'test_url',
+          'image' => 'test_file',
+          'focus_x' => '5',
+          'focus_y' => '5'
+        }
+      )
+    end
+  end
+
+  describe '#send' do
+    let(:params) { { locale: 'en', url: 'test_url' } }
+
+    it 'returns the proper result' do
+      stub_post(
+        path: '/v1/images',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('image_request.json')
+      )
+
+      response = described_class.send(params)
+
+      expect(response["token"]).to  eq "sample_token"
+      expect(response["url"]).to    eq "https://example.com/image.jpg"
+      expect(response["status"]).to eq "not completed"
+    end
+
+    it 'responds correctly to a response exception error' do
+      stub_post(
+        path: '/v1/images',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('error_response.json')
+      )
+
+      expect { described_class.send(params) }.to raise_error Cloudsight::ResponseException
+    end
+
+    it 'responds correctly to an unexpected response' do
+      stub_post(
+        path: '/v1/images',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('unexpected_response.json')
+      )
+
+      expect { described_class.send(params) }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+
+    it 'responds correctly to an invalid JSON response' do
+      stub_post(
+        path: '/v1/images',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('invalid_json.json')
+      )
+
+      expect { described_class.send(params) }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+  end
+
+  describe '#repost' do
+    let(:params) { { locale: 'en', remote_image_url: 'test_url' } }
+
+    it 'returns the proper result' do
+      stub_post(
+        path: '/v1/images/sample_token/repost',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('image_request.json')
+      )
+
+      response = described_class.repost('sample_token', params)
+
+      expect(response["token"]).to  eq "sample_token"
+      expect(response["url"]).to    eq "https://example.com/image.jpg"
+      expect(response["status"]).to eq "not completed"
+    end
+
+    it 'responds correctly to a response exception error' do
+      stub_post(
+        path: '/v1/images/sample_token/repost',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('error_response.json')
+      )
+
+      expect { described_class.repost('sample_token', params) }.to raise_error Cloudsight::ResponseException
+    end
+
+    it 'responds correctly to an unexpected response' do
+      stub_post(
+        path: '/v1/images/sample_token/repost',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('unexpected_response.json')
+      )
+
+      expect { described_class.repost('sample_token', params) }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+
+    it 'responds correctly to an invalid JSON response' do
+      stub_post(
+        path: '/v1/images/sample_token/repost',
+        body: { "locale" => "en", "remote_image_url" => "test_url" },
+        response: fixture_file('invalid_json.json')
+      )
+
+      expect { described_class.repost('sample_token', params) }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+  end
+end

data/spec/cloudsight/response_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+RSpec.describe Cloudsight::Response do
+  before(:each) do
+    Cloudsight.api_key = 'test_api_key'
+  end
+
+  describe '#get' do
+    it 'returns the proper result' do
+      stub_get(
+        path: '/v1/images/sample_token',
+        response: fixture_file('completed_response.json')
+      )
+
+      response = described_class.get('sample_token')
+
+      expect(response["token"]).to  eq "sample_token"
+      expect(response["url"]).to    eq "http://www.example.com/your_headphones_image.jpg"
+      expect(response["status"]).to eq "completed"
+    end
+
+    it 'responds correctly to a response exception error' do
+      stub_get(
+        path: '/v1/images/sample_token',
+        response: fixture_file('error_response.json')
+      )
+
+      expect { described_class.get('sample_token') }.to raise_error Cloudsight::ResponseException
+    end
+
+    it 'responds correctly to an unexpected response' do
+      stub_get(
+        path: '/v1/images/sample_token',
+        response: fixture_file('unexpected_response.json')
+      )
+
+      expect { described_class.get('sample_token') }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+
+    it 'responds correctly to an invalid JSON response' do
+      stub_get(
+        path: '/v1/images/sample_token',
+        response: fixture_file('invalid_json.json')
+      )
+
+      expect { described_class.get('sample_token') }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+  end
+
+  describe '#retrieve' do
+    it 'returns the proper result' do
+      stub_polling(3, 'image_request.json', 'completed_response.json', '/v1/images/sample_token')
+
+      response = described_class.retrieve('sample_token', poll_wait: 0.01)
+
+      expect(response["token"]).to  eq "sample_token"
+      expect(response["url"]).to    eq "http://www.example.com/your_headphones_image.jpg"
+      expect(response["status"]).to eq "completed"
+    end
+
+    it 'responds correctly to a response exception error' do
+      stub_polling(3, 'image_request.json', 'error_response.json', '/v1/images/sample_token')
+
+      expect { described_class.retrieve('sample_token', poll_wait: 0.01) }.to raise_error Cloudsight::ResponseException
+    end
+
+    it 'responds correctly to an unexpected response' do
+      stub_polling(3, 'image_request.json', 'unexpected_response.json', '/v1/images/sample_token')
+
+      expect { described_class.retrieve('sample_token', poll_wait: 0.01) }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+
+    it 'responds correctly to an invalid JSON response' do
+      stub_polling(3, 'image_request.json', 'invalid_json.json', '/v1/images/sample_token')
+
+      expect { described_class.retrieve('sample_token', poll_wait: 0.01) }.to raise_error Cloudsight::UnexpectedResponseException
+    end
+  end
+end
+
+def stub_polling(num_retries, file_1, file_2, path)
+  retries = 0
+  while retries < num_retries
+    stub_get(path: path, response: fixture_file(file_1))
+    retries += 1
+  end
+
+  stub_get(path: path, response: fixture_file(file_2))
+end

data/spec/cloudsight_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'simple_oauth'
+
+RSpec.describe Cloudsight do
+  context 'initialization' do
+    it 'should assign the proper basic attributes' do
+      Cloudsight.api_key  = 'test_api_key'
+      Cloudsight.base_url = 'test_base_url'
+
+      expect(Cloudsight.api_key) .to eq 'test_api_key'
+      expect(Cloudsight.base_url).to eq 'test_base_url'
+    end
+
+    it 'should configure the oauth_options correctly' do
+      Cloudsight.oauth_options = {
+        consumer_key: 'test_consumer_key',
+        consumer_secret: 'test_consumer_secret'
+      }
+
+      expect(Cloudsight.oauth_options[:consumer_key]).to    eq 'test_consumer_key'
+      expect(Cloudsight.oauth_options[:consumer_secret]).to eq 'test_consumer_secret'
+    end
+  end
+end

data/spec/fixtures/completed_response.json

@@ -0,0 +1,8 @@
+{
+  "status" : "completed",
+  "name" : "red beats by dre headphones",
+  "flags" : [],
+  "ttl" : 60,
+  "url" : "http://www.example.com/your_headphones_image.jpg",
+  "token" : "sample_token"
+}

data/spec/fixtures/error_response.json

@@ -0,0 +1,9 @@
+{
+  "status" : "completed",
+  "name" : "red beats by dre headphones",
+  "error": "test_error",
+  "flags" : [],
+  "ttl" : 60,
+  "url" : "http://www.example.com/your_headphones_image.jpg",
+  "token" : "sample_token"
+}

data/spec/fixtures/image_request.json

@@ -0,0 +1,5 @@
+{
+  "token": "sample_token",
+  "url": "https://example.com/image.jpg",
+  "status": "not completed"
+}

data/spec/fixtures/invalid_json.json

@@ -0,0 +1,9 @@
+<html><head>
+<meta http-equiv="content-type" content="text/html;charset=utf-8">
+<title>502 Server Error</title>
+</head>
+<body text=#000000 bgcolor=#ffffff>
+<h1>Error: Server Error</h1>
+<h2>The server encountered a temporary error and could not complete your request.<p>Please try again in 30 seconds.</h2>
+<h2></h2>
+</body></html>

data/spec/fixtures/unexpected_response.json

@@ -0,0 +1,6 @@
+{
+  "name" : "red beats by dre headphones",
+  "flags" : [],
+  "ttl" : 60,
+  "url" : "http://www.example.com/your_headphones_image.jpg"
+}

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require 'bundler/setup'
+require 'cloudsight'
+require 'webmock/rspec'
+require 'pry'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.after(:each) do
+    Cloudsight.api_key       = nil
+    Cloudsight.oauth_options = {}
+    Cloudsight.base_url      = nil
+  end
+
+end
+
+def stub_get(path:, response:, status: 200, message: nil)
+  stub_request(:get, Cloudsight::BASE_URL + path).to_return(
+    status: status,
+    body: response,
+    exception: message
+  )
+end
+
+def stub_post(path:, body: {}, response: {}, status: 200, message: nil)
+  stub_request(:post, Cloudsight::BASE_URL + path).with(
+    body: hash_including(body)
+  ).to_return(
+    status: status,
+    body: response,
+    exception: message
+  )
+end
+
+def fixture_file(filename, options={})
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  fixture   = File.read(file_path)
+
+  case File.extname(file_path)
+  when '.json'
+    options[:parse] ? JSON.parse(fixture) : fixture
+  else
+    fixture
+  end
+end
+

metadata

@@ -1,88 +1,168 @@
 --- !ruby/object:Gem::Specification
 name: cloudsight
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - Brad Folkens
-autorequire: 
+- Jack McCallum
+- Chris Weilemann
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 description: A simple CloudSight API Client for Image Recognition
-email: brad@cloudsightapi.com
-executables: []
+email: oss@cloudsight.ai
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - cloudsight.gemspec
 - lib/cloudsight.rb
+- lib/cloudsight/api.rb
+- lib/cloudsight/request.rb
+- lib/cloudsight/response.rb
+- lib/cloudsight/version.rb
+- spec/cloudsight/api_spec.rb
+- spec/cloudsight/request_spec.rb
+- spec/cloudsight/response_spec.rb
+- spec/cloudsight_spec.rb
+- spec/fixtures/completed_response.json
+- spec/fixtures/error_response.json
+- spec/fixtures/image_request.json
+- spec/fixtures/invalid_json.json
+- spec/fixtures/unexpected_response.json
+- spec/spec_helper.rb
 homepage: http://github.com/cloudsight/cloudsight-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,16 +170,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: CloudSight API Client
-test_files: []
+test_files:
+- spec/cloudsight/api_spec.rb
+- spec/cloudsight/request_spec.rb
+- spec/cloudsight/response_spec.rb
+- spec/cloudsight_spec.rb
+- spec/fixtures/completed_response.json
+- spec/fixtures/error_response.json
+- spec/fixtures/image_request.json
+- spec/fixtures/invalid_json.json
+- spec/fixtures/unexpected_response.json
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cloudsight (0.0.2)
-      json
-      rest-client (~> 1.6)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    domain_name (0.5.20170404)
-      unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    json (2.1.0)
-    mime-types (2.99.3)
-    netrc (0.11.0)
-    rake (12.0.0)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.6)
-  cloudsight!
-  rake
-
-BUNDLED WITH
-   1.13.7