getty_connect_authentication 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3399b5809d6053c1a4724921690498b30e70600
+  data.tar.gz: a3a0e582230a2f9e1bde90e78c041e7d2b4dbc0c
+SHA512:
+  metadata.gz: e48f7c7d37efe503f486bb603053d83b182dc2a4094874fe191a0c8c21dc70e4d6e396d664fdd3abe2e009fc9700cd4ba805bcd114cc3336a31948aba2101036
+  data.tar.gz: 89c9f1a6886d0374150f44cedb198addd035786844bf0dc958d94664ccdefb21848c34406263268b1558df69968e9823fa5fe62a15cb2337251096587eba7770

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cymen Vig
+
+MIT License
+
+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,50 @@
+# GettyConnectAuthentication
+
+Access the Getty Connect API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'getty_connect_authentication'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install getty_connect_authentication
+
+## Completion
+
+Only a subset of the API is implemented so far:
+
+* getting a token
+* searching for images
+
+## Usage
+
+### Configuration
+
+`config/initializers/getty_connect_authentication.rb`:
+
+    require 'getty_connect_authentication'
+    GettyConnectAuthentication::Configuration.load(File.join(Rails.root, 'config', 'getty_config.yml'))
+
+`getty_config.yml`:
+
+    id: provided by Getty
+    secret: provided by Getty
+
+### Examples
+
+See the example directory.
+
+## Contributing
+
+1. Fork it ( https://github.com/cymen/getty_connect_authentication/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/config.yml.sample

@@ -0,0 +1,2 @@
+id: the id from Getty Connect
+secret: the secret from Getty Connect

data/example/token.rb

@@ -0,0 +1,5 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'getty_connect_authentication'
+
+GettyConnectAuthentication::Configuration.load(File.expand_path('../../config.yml', __FILE__))
+puts GettyConnectAuthentication.token

data/getty_connect_authentication.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'getty_connect_authentication/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "getty_connect_authentication"
+  spec.version       = GettyConnectAuthentication::VERSION
+  spec.authors       = ["Cymen Vig"]
+  spec.email         = ["cymenvig@gmail.com"]
+  spec.summary       = "Authentication for the Getty Images Connect API"
+  spec.description   = "Fetch authentication tokens from the Getty Images Connect API v2"
+  spec.homepage      = "https://github.com/cymen/getty_connect_authentication"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0") - %w(config.yml .ruby-gemset .ruby-version .gitignore)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "webmock", "~> 1.17"
+end

data/lib/getty_connect_authentication.rb

@@ -0,0 +1,42 @@
+require 'getty_connect_authentication/version'
+require 'getty_connect_authentication/configuration'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module GettyConnectAuthentication
+  BASE_URI = 'https://connect.gettyimages.com'
+  PATH = 'oauth2/token'
+
+  def self.token
+    uri = self.uri
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.is_a?(URI::HTTPS)
+
+    body = {
+      client_id: Configuration.id,
+      client_secret: Configuration.secret,
+      grant_type: 'client_credentials'
+    }
+
+    request = Net::HTTP::Post.new(uri.request_uri)
+    request.set_form_data(body)
+    response = http.request(request)
+
+    case response.code.to_i
+    when 200
+      JSON.parse(response.body)
+    else
+      raise "#{response.code} response code with body: #{response.body}"
+    end
+  end
+
+  def self.uri
+    URI.parse "#{BASE_URI}/#{PATH}"
+  end
+
+  def self.reset
+    @token = nil
+    @expires = nil
+  end
+end

data/lib/getty_connect_authentication/configuration.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+module GettyConnectAuthentication
+  module Configuration
+
+    def self.load(path_to_yaml_file)
+      begin
+        configuration = YAML::load(IO.read(path_to_yaml_file))
+        @id = configuration['id']
+        @secret = configuration['secret']
+        @username = configuration['username']
+        @password = configuration['password']
+        return
+      rescue Errno::ENOENT
+        raise "YAML configuration file \"#{path_to_yaml_file}\" couldn't be found. Using defaults."
+      rescue Psych::SyntaxError
+        raise "YAML configuration file contains invalid syntax. Using defaults."
+      end
+    end
+
+    def self.id
+      @id
+    end
+
+    def self.secret
+      @secret
+    end
+
+    def self.username
+      @username
+    end
+
+    def self.password
+      @password
+    end
+
+    def self.reset
+      @id = nil
+      @secret = nil
+      @username = nil
+      @password = nil
+    end
+
+  end
+end

data/lib/getty_connect_authentication/version.rb

@@ -0,0 +1,3 @@
+module GettyConnectAuthentication
+  VERSION = "0.0.1"
+end

data/spec/getty/connect/configuration_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe GettyConnectAuthentication::Configuration do
+
+  it 'returns nil by default for id' do
+    GettyConnectAuthentication::Configuration.id.should be_nil
+  end
+
+  it 'returns nil by default for secret' do
+    GettyConnectAuthentication::Configuration.secret.should be_nil
+  end
+
+  it 'can be configured with a YAML file' do
+    GettyConnectAuthentication::Configuration.load(File.join(File.dirname(__FILE__), 'fixtures', 'a.yml'))
+
+    GettyConnectAuthentication::Configuration.id.should == 'abc123'
+    GettyConnectAuthentication::Configuration.secret.should == 'big_secret'
+  end
+
+  it 'raises an error if the file is not present' do
+    expect { GettyConnectAuthentication::Configuration.load('does_not_exist.yml') }.to raise_error
+  end
+
+  it 'raises an error if the file is not valid YAML' do
+    expect {
+      GettyConnectAuthentication::Configuration.load(File.join(File.dirname(__FILE__), 'fixtures', 'b.yml'))
+    }.to raise_error
+  end
+end

data/spec/getty/connect/fixtures/a.yml

@@ -0,0 +1,2 @@
+id: abc123
+secret: big_secret

data/spec/getty/connect/fixtures/b.yml

@@ -0,0 +1 @@
+id: %xyz

data/spec/getty/connect_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe GettyConnectAuthentication do
+
+  specify 'uri returns the URI' do
+    GettyConnectAuthentication.uri.to_s.should == 'https://connect.gettyimages.com/oauth2/token'
+  end
+
+  describe 'token' do
+    url = nil
+
+    before(:each) do
+      GettyConnectAuthentication.reset
+      GettyConnectAuthentication::Configuration.load(File.join(File.dirname(__FILE__), 'fixtures', 'getty.yml'))
+      url = "#{GettyConnectAuthentication::BASE_URI}/oauth2/token"
+    end
+
+    it 'sends a request to BASE_URI/oauth2/token' do
+      stub_request(:any, url).to_return(
+        status: 200,
+        headers: {'Content-Type' => 'application/json'},
+        body: {access_token: 'a', expires_in: 10}.to_json
+      )
+
+      GettyConnectAuthentication.token
+
+      a_request(:post, url).
+        with(body: "client_id=my_id&client_secret=my_secret&grant_type=client_credentials").should have_been_made.once
+    end
+
+    it 'sets expires to current timestamp plus response expires_in value' do
+      stub_request(:any, url).to_return(
+        status: 200,
+        headers: {'Content-Type' => 'application/json'},
+        body: {access_token: 'a', expires_in: 10}.to_json
+      )
+
+      response = GettyConnectAuthentication.token
+
+      response['expires_in'].should be_within(1).of(10)
+    end
+
+    it 'returns the token in the response' do
+      stub_request(:any, url).to_return(
+        status: 200,
+        headers: {'Content-Type' => 'application/json'},
+        body: {access_token: 'the_token', expires_in: 10}.to_json
+      )
+
+      response = GettyConnectAuthentication.token
+
+      response['access_token'].should == 'the_token'
+    end
+
+    it 'raises an error if the response code is not 200' do
+      stub_request(:any, url).to_return(status: 403)
+
+      expect { GettyConnectAuthentication.token }.to raise_error
+    end
+
+  end
+end

data/spec/getty/fixtures/getty.yml

@@ -0,0 +1,2 @@
+id: my_id
+secret: my_secret

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'webmock/rspec'
+require 'getty_connect_authentication'
+require 'getty_connect_authentication/configuration'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: getty_connect_authentication
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cymen Vig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: Fetch authentication tokens from the Getty Images Connect API v2
+email:
+- cymenvig@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.yml.sample
+- example/token.rb
+- getty_connect_authentication.gemspec
+- lib/getty_connect_authentication.rb
+- lib/getty_connect_authentication/configuration.rb
+- lib/getty_connect_authentication/version.rb
+- spec/getty/connect/configuration_spec.rb
+- spec/getty/connect/fixtures/a.yml
+- spec/getty/connect/fixtures/b.yml
+- spec/getty/connect_spec.rb
+- spec/getty/fixtures/getty.yml
+- spec/spec_helper.rb
+homepage: https://github.com/cymen/getty_connect_authentication
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Authentication for the Getty Images Connect API
+test_files:
+- spec/getty/connect/configuration_spec.rb
+- spec/getty/connect/fixtures/a.yml
+- spec/getty/connect/fixtures/b.yml
+- spec/getty/connect_spec.rb
+- spec/getty/fixtures/getty.yml
+- spec/spec_helper.rb