transistor-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd19ca5b07bdb3a6002473d0f18e5b074db1ca86
+  data.tar.gz: 81a8a25f1cb0fadfeb701a2ef5f4dd29e760af56
+SHA512:
+  metadata.gz: 01f12e7b45bd306156213b7b3cc8a8d38914418821368690b16b7c1826469487447bae8f37412114a8f2d34eabcbb4f45820c308aa17a1df82b376c009604cb1
+  data.tar.gz: 78fd3eff81637c3152f92f39d065109a8d4ba996c7ec95f5126eb0cf0f50d6d04ed2614556db601ef5d677128d5a189d2a427e8e9e1b667b4f92ad74fe5c6690

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (C) Original Machine, LLC.
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/Readme.md

@@ -0,0 +1,56 @@
+# Transistor
+
+Transistor is a powerful digital metrics platform from [Original Machine](http://originalmachine.com) that is currently in beta. This gem provides an interface to the Transistor API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transistor-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transistor-client
+
+## Usage
+
+First, [sign in](http://transistor.fm) and create an Application. Then, add your credentials, maybe in an initializer:
+
+```ruby
+Transistor.configure do |config|
+  config.id = 'xxxxxx'
+	config.secret = 'xxxxxx'
+end
+```
+
+You can also override the default settings, if you can't connect via ```https```, or wish to use an alternate host:
+
+```ruby
+Transistor.setup do |config|
+  config.host = 'api.transistor.fm'
+  config.secure = false
+end
+```
+
+### Making Requests
+
+```ruby
+client = Transistor::Client.new
+client.get('/channels')
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+© 2013 Original Machine, LLC. Released under the MIT License.

data/lib/transistor/client.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'transistor/middleware/authentication'
+require 'transistor/error'
+
+module Transistor
+  class Client
+    def connection_options
+      @collection_options ||= {
+        builder: middleware,
+        headers: {
+          accept: 'application/json',
+          user_agent: Transistor.config.user_agent
+        },
+        request: {
+          open_timeout: 5,
+          timeout: 10
+        }
+      }
+    end
+    
+    def middleware
+      @middleware = Faraday::Builder.new do |builder|
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Transistor::Middleware::Authentication
+        builder.adapter Faraday.default_adapter
+      end
+    end
+    
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+    
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+    
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+    
+    def put(path, params = {})
+      request(:put, path, params)
+    end
+    
+    private
+    
+    def connection
+      @connection ||= Faraday.new Transistor.config.base_url, connection_options do |conn|
+        conn.response :json, content_type: /\bjson$/
+      end
+    end
+    
+    def request(method, path, params = {})
+      response = connection.send(method.to_sym, path, params) do |request|
+      end
+      response.env
+    rescue Faraday::Error::ClientError => error
+      raise Transistor::Error.new(err)
+    end
+  end
+end

data/lib/transistor/error.rb

@@ -0,0 +1,7 @@
+module Transistor
+  class Error < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/transistor/middleware/authentication.rb

@@ -0,0 +1,33 @@
+require 'hawk'
+
+module Transistor
+  module Middleware
+    class Authentication < Faraday::Middleware
+      AUTHORIZATION_HEADER = 'Authorization'.freeze
+      CONTENT_TYPE_HEADER = 'Content-Type'.freeze
+      
+      def initalize(app, options = {})
+        super(app)
+      end
+      
+      def call(env)
+        env[:request_headers][AUTHORIZATION_HEADER] = authorize_request(env)
+        @app.call(env)
+      end
+      
+      private
+      
+      def authorize_request(env)
+        Hawk::Client.build_authorization_header(
+          credentials: Transistor.config.credentials,
+          ts: Time.now.to_i,
+          content_type: env[:request_headers][CONTENT_TYPE_HEADER].to_s.split(';').first,
+          method: env[:method].to_s.upcase,
+          port: env[:url].port || (env[:url].scheme == 'https' ? 443 : 80),
+          host: env[:url].host,
+          request_uri: env[:url].to_s.sub(%r{\A#{env[:url].scheme}://#{env[:url].host}(:#{env[:url].port})?}, '')
+        )
+      end
+    end
+  end
+end

data/lib/transistor/version.rb

@@ -0,0 +1,3 @@
+module Transistor
+  Version = '0.0.1'
+end

data/lib/transistor.rb

@@ -0,0 +1,42 @@
+require 'transistor/version'
+require 'transistor/client'
+
+module Transistor  
+  class << self
+    attr_accessor :config
+  end
+  
+  class Config
+    attr_accessor :id, :secret, :host, :secure
+    
+    def initialize
+      @host = 'api.transistor.fm'
+      @secure = true
+    end
+    
+    def base_url
+      if self.secure
+        "https://#{self.host}"
+      else
+        "http://#{self.host}"
+      end
+    end
+    
+    def credentials
+      {
+        id: self.id,
+        key: self.secret,
+        algorithm: 'sha256'
+      }
+    end
+    
+    def user_agent
+      "Transistor Ruby Client, Version #{Transistor::Version}"
+    end
+  end
+  
+  def self.setup
+    self.config ||= Config.new
+    yield(config)
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Transistor do
+  context 'defaults' do
+    before do
+      Transistor.setup do |config|
+        config.id = '103031111'
+        config.secret = 'xxxx40'
+      end
+    end
+  
+    it 'should store configuration information' do
+      expect(Transistor.config.id).to eq('103031111')
+      expect(Transistor.config.secret).to eq('xxxx40')
+    end
+  
+    it 'should default to https' do
+      expect(Transistor.config.secure).to eq(true)
+    end
+  
+    it 'should default to api.transistor.fm as the host' do
+      expect(Transistor.config.host).to eq('api.transistor.fm')
+    end
+  end
+  
+  context 'Overriding defaults' do
+    before do
+      Transistor.setup do |config|
+        config.id = '1030311101'
+        config.secret = 'xxxx400'
+        config.host = 'api.transistor.dev'
+        config.secure = false
+      end
+    end
+    
+    it 'should override the host and secure config' do
+      expect(Transistor.config.host).to eq('api.transistor.dev')
+      expect(Transistor.config.secure).to eq(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'transistor'
+
+RSpec.configure do |config|
+end

data/transistor-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transistor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'transistor-client'
+  spec.version       = Transistor::Version
+  spec.authors       = ['Nicholas Young']
+  spec.email         = ['nicholas@originalmachine.com']
+  spec.description   = %q{The official Ruby client for Transistor.FM, a digital media analytics platform from Original Machine.}
+  spec.summary       = %q{A client for the Transistor.FM media analytics platform.}
+  spec.homepage      = 'http://transistor.fm'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1.1'
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  
+  spec.add_dependency 'faraday', '~> 0.8.8'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.0'
+  spec.add_dependency 'json', '~> 1.8.1'
+  spec.add_dependency 'hawk-auth', '~> 0.2.4'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: transistor-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicholas Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: hawk-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: The official Ruby client for Transistor.FM, a digital media analytics
+  platform from Original Machine.
+email:
+- nicholas@originalmachine.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- lib/transistor.rb
+- lib/transistor/client.rb
+- lib/transistor/error.rb
+- lib/transistor/middleware/authentication.rb
+- lib/transistor/version.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+- transistor-client.gemspec
+homepage: http://transistor.fm
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A client for the Transistor.FM media analytics platform.
+test_files:
+- spec/config_spec.rb
+- spec/spec_helper.rb