bitsontherun 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+nbproject

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+--format
+documentation
+mtime

data/Gemfile

@@ -0,0 +1,2 @@
+source :gemcutter
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    bitsontherun (0.0.1)
+      curb (= 0.7.10)
+      json (= 1.5.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    curb (0.7.10)
+    diff-lcs (1.1.2)
+    json (1.5.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitsontherun!
+  bundler (= 1.0.10)
+  rspec (= 2.4.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Adrian Dulic
+
+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,78 @@
+BitsOnTheRun
+==============
+
+BitsOnTheRun is an implementation of [bitsontherun.com](bitsontherun.com) API in Ruby.
+
+## Install
+
+Gemfile:
+
+    gem 'bitsontherun', :git => 'http://github.com/adriandulic/bitsontherun.git'
+
+Setup:
+
+    BitsOnTheRun::Configuration.key = "your api key"
+    BitsOnTheRun::Configuration.secret = "your api secret"
+
+## Usage
+
+Basic:
+
+    BitsOnTheRun::call('version') => {:status => "ok", :version => "X.X.X"}
+    
+    BitsOnTheRun::store('videos/create', 'video.mp4') => {:status => "ok", ...}
+    
+    BitsOnTheRun::call('videos/update', :video_key => 'your video key', :title => 'New title for video').ok? => true
+
+Extended:
+
+    call = BitsOnTheRun::API.new(:call)
+    call.method('videos/list')
+    call.execute
+    
+    call = BitsOnTheRun::API.new(:call)
+    call.method('videos/show', :video_key => 'your video key')
+    call.execute
+    
+    call = BitsOnTheRun::API.new(:call)
+    call.method('videos/update', :video_key => 'your video key', :title => 'New title for video')
+    call.execute
+    
+    call = BitsOnTheRun::API.new(:store)
+    call.method('videos/create')
+    call.file('video.mp4')
+    call.execute
+
+## How to navigate through response
+
+Request:
+
+    BitsOnTheRun::call('accounts/show')
+
+Response:
+
+    {:account => {:cdn => {:name => "Value" }}}
+
+Find methods:
+
+    response.account.cdn.name => "Value"
+    response.account.cdn(:name) => "Value"
+    response.account(:cdn, :name) => "Value"
+    response.account([:cdn, :name]) => "Value"
+    response.find(:account, :cdn, :name) => "Value"
+    response.find([:account, :cdn, :name]) => "Value"
+
+
+Request:
+
+    BitsOnTheRun::call('videos/list')
+
+Response:
+
+    {:videos => [{ video }, { ... }, ...]}
+
+Find methods:
+
+    response.videos => [<BitsOnTheRun::Response>, <BitsOnTheRun::Response>, ...]
+    response.videos.first => <BitsOnTheRun::Response>
+    repsonse.videos.first.title => "Video title"

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rspec"
+require "rspec/core/rake_task"
+
+Rspec::Core::RakeTask.new(:spec)

data/bitsontherun.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/bitsontherun/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "bitsontherun"
+  s.version     = BitsOnTheRun::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Adrian Dulic']
+  s.email       = ['adulic@gmail.com']
+  s.homepage    = "http://github.com/adriandulic/bitsontherun"
+  s.summary     = "BitsOnTheRun.com API implementation in Ruby"
+  s.description = "BitsOnTheRun.com API implementation in Ruby"
+  
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "bitsontherun"
+  
+  s.add_dependency "json", "1.5.1"
+  s.add_dependency "curb", "0.7.10"
+  
+  s.add_development_dependency "bundler", "1.0.10"
+  s.add_development_dependency "rspec", "2.4.0"
+  
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/bitsontherun.rb

@@ -0,0 +1,64 @@
+require 'curb'
+require 'cgi'
+require 'uri'
+
+module BitsOnTheRun
+  PROTOCOL = "http"
+  URL = "api.bitsontherun.com"
+  API_VERSION = "v1"
+  
+  autoload :API,            "bitsontherun/api"
+  autoload :Configuration,  "bitsontherun/configuration"
+  autoload :Call,           "bitsontherun/call"
+  autoload :Store,          "bitsontherun/store"
+  autoload :Response,       "bitsontherun/response"
+  autoload :Parser,         "bitsontherun/parser"
+  
+  class Base
+    def initialize
+      @params = {}
+    end
+    
+    def method(method, params = {})
+      @method = method.to_s
+      @params.merge!(params.to_hash)
+    end
+    
+    protected
+      def build_url
+        URI.escape("#{PROTOCOL}://#{URL}/#{API_VERSION}/#{@method}?#{build_params}")
+      end
+      
+      def build_params
+        @defaults.merge!(@params)
+        @defaults[:api_signature] = build_signature
+        escape_params
+      end
+      
+      def build_signature
+        signature = escape_params
+        Digest::SHA1.hexdigest(signature + Configuration.secret)
+      end
+      
+      def escape_params
+        params = @defaults.merge(@defaults) { |key, param| URI.escape(param.to_s) }
+        params = params.map { |key, param| "#{key}=#{param}"}
+        params.sort.join("&")
+      end
+  end
+  
+  class << self
+    def call(method, params = {})
+      adapter = API.new(:call)
+      adapter.method(method, params)
+      adapter.execute
+    end
+    
+    def store(method, filename, params = {})
+      adapter = API.new(:store)
+      adapter.method(method, params)
+      adapter.file(filename)
+      adapter.execute
+    end
+  end
+end

data/lib/bitsontherun/api.rb

@@ -0,0 +1,28 @@
+module BitsOnTheRun
+  class API
+    def initialize(adapter)
+      @adapter = BitsOnTheRun.const_get(adapter.to_s.capitalize).new
+    end
+    
+    def method(method, params = {})
+      if params.include?(:api_format)
+        raise ArgumentError("Params hash should not include :api_format, use BitsOnTheRun::Configuration.format instead")
+      end
+      if params.include?(:api_key)
+        raise ArgumentError("Params hash should not include :api_key, use BitsOnTheRun::Configuration.key instead")
+      end
+      if params.include?(:api_secret)
+        raise ArgumentError("Params hash should not include :api_secret, use BitsOnTheRun::Configuration.secret instead")
+      end
+      @adapter.method(method, params)
+    end
+    
+    def file(file)
+      @adapter.file(file)
+    end
+    
+    def execute
+      @adapter.execute
+    end
+  end
+end

data/lib/bitsontherun/call.rb

@@ -0,0 +1,22 @@
+require 'digest/sha1'
+require 'net/http'
+
+module BitsOnTheRun
+  class Call < Base
+    def initialize
+      @defaults = {
+        :api_nonce => "%08d" % rand(99999999),
+        :api_timestamp => Time.now.to_i,
+        :api_key => Configuration.key,
+        :api_format => Configuration.format,
+        :api_kit => "ruby-%s" % VERSION
+      }
+      super
+    end
+    
+    def execute
+      response = Curl::Easy.perform(build_url).body_str
+      Response.new(response)
+    end
+  end
+end

data/lib/bitsontherun/configuration.rb

@@ -0,0 +1,10 @@
+module BitsOnTheRun
+  class Configuration
+    class << self
+      attr_accessor :key
+      attr_accessor :secret
+
+      def format; "json"; end
+    end
+  end
+end

data/lib/bitsontherun/parser.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module BitsOnTheRun
+  module Parser
+    extend self
+    
+    def parse(response)
+      JSON.parse(response, :symbolize_names => true)
+    end
+  end
+end

data/lib/bitsontherun/response.rb

@@ -0,0 +1,58 @@
+module BitsOnTheRun
+  class Response
+    def initialize(response, hash=false)
+      @response = response
+      if hash
+        @parsed = response
+      else
+        @parsed = Parser::parse(response)
+      end
+    end
+    
+    def ok?
+      status == "ok"
+    end
+    
+    def error?
+      status == "error"
+    end
+    
+    def hash
+      to_hash
+    end
+    
+    def to_hash
+      @parsed
+    end
+    
+    def find(*args)
+      if args.first.class == Array
+        args = args.first
+      end
+      name = args.shift.to_sym
+      if @parsed.has_key?(name)
+        data = @parsed[name]
+        if args.first.class == Array
+          args = args.first
+        end
+        args.each do |arg|
+          data = data[arg]
+        end
+        if data.class == Hash
+          data = self.class.new(data, true)
+        end
+        if data.class == Array
+          data.map! { |d| self.class.new(d, true) }
+        end
+        data
+      else
+        nil
+      end
+    end
+    
+    def method_missing(name, *args)
+      args.unshift(name)
+      find(*args)
+    end
+  end
+end

data/lib/bitsontherun/store.rb

@@ -0,0 +1,42 @@
+module BitsOnTheRun
+  class Store < Base
+    def initialize
+      @response = nil
+      @defaults = {
+        :api_format => Configuration.format
+      }
+      super
+    end
+    
+    def file(filename)
+      @filename = filename.to_s
+    end
+    
+    def execute
+      build_token
+      file = Curl::PostField.file("file", @filename)
+      response = Curl::Easy.http_post(build_store_url, file) do |curl|
+        curl.multipart_form_post = true
+      end.body_str
+      Response.new(response)
+    end
+    
+    private
+      def build_token
+        call = API.new(:call)
+        call.method(@method, @params)
+        @response = call.execute
+      end
+      
+      def build_store_url
+        protocol = @response.find(:link, :protocol)
+        address = @response.find(:link, :address)
+        path = @response.find(:link, :path)
+        
+        @defaults[:key] = @response.find(:link, :query, :key)
+        @defaults[:token] = @response.find(:link, :query, :token)
+      
+        URI.escape("#{protocol}://#{address}#{path}?#{escape_params}")
+      end
+  end
+end

data/lib/bitsontherun/version.rb

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

data/spec/lib/account_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe "API call to retrieve account" do
+  it_should_behave_like "Successful response"
+  
+  before do
+    @responses = []
+    @responses << BitsOnTheRun::call('accounts/show', :account_key => BitsOnTheRun::Configuration.key)
+    
+    @manual = BitsOnTheRun::API.new(:call)
+    @manual.method('accounts/show', :account_key => BitsOnTheRun::Configuration.key)
+    @responses << @manual.execute
+  end
+  
+  it "should contain information about specific account" do
+    @responses.each do |r|
+      r.find(:account, :cdn, :name).should be_instance_of String
+      r.find([:account, :cdn, :name]).should be_instance_of String
+      r.find(:account, [:cdn, :name]).should be_instance_of String
+      r.account(:cdn, :name).should be_instance_of String
+      r.account([:cdn, :name]).should be_instance_of String
+      r.account.cdn(:name).should be_instance_of String
+      r.account.cdn.name.should be_instance_of String
+    end
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe "Configuration" do
+  before do
+    @key = BitsOnTheRun::Configuration.key
+    @secret = BitsOnTheRun::Configuration.secret
+  end
+
+  it "should store configuration information in class attributes" do
+    BitsOnTheRun::Configuration.key    = "your api key"
+    BitsOnTheRun::Configuration.secret = "your api secret"
+
+    BitsOnTheRun::Configuration.key.should    == "your api key"
+    BitsOnTheRun::Configuration.secret.should == "your api secret"
+    BitsOnTheRun::Configuration.format.should == "json"
+  end
+
+  after do
+    BitsOnTheRun::Configuration.key    = @key
+    BitsOnTheRun::Configuration.secret = @secret
+  end
+end

data/spec/lib/delete_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "API call to delete video files" do
+  it_should_behave_like "Successful response"
+  
+  before do
+    @video = BitsOnTheRun::store('videos/create', 'spec/test.mp4')
+    @responses = BitsOnTheRun::call('videos/delete', :video_key => @video.media.key)
+  end
+  
+  it "should contain confirmation about deleted video" do
+    @responses.each do |r|
+      r.ok?.should be_true
+    end
+  end
+end

data/spec/lib/error_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "API call to non existent resource" do
+  it_should_behave_like "Error response"
+  
+  before do
+    @responses = []
+    @responses << BitsOnTheRun::call('videos/show', :video_key => 'wrong key here')
+  end
+  
+  it "should contain information about error" do
+    @responses.each do |r|
+      r.video
+      r.code.should eql("NotFound")
+      r.title.should eql("Not Found")
+      r.message.should eql("video_key: Video with the key wrong key here does not exist")
+    end
+  end
+end

data/spec/lib/parse_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe "Response JSON parser" do
+  before do
+    @json = '{"status": "ok", "other": {"name": "Valid"}}'
+  end
+  
+  it "should parse JSON string to Hash" do
+    output = BitsOnTheRun::Parser.parse(@json)
+    output.should be_instance_of Hash
+    output.should have_key :status
+    output.should have_key :other
+    output[:status].should eql("ok")
+    output[:other].should have_key :name
+    output[:other][:name].should eql("Valid")
+  end
+end

data/spec/lib/store_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "API call to store new video file" do
+  it_should_behave_like "Successful response"
+  
+  before do
+    @responses = []
+    @file = 'spec/test.mp4'
+    @responses << BitsOnTheRun::store('videos/create', @file)
+    
+    @manual = BitsOnTheRun::API.new(:store)
+    @manual.method('videos/create')
+    @manual.file(@file)
+    @responses << @manual.execute
+  end
+  
+  it "should contain information about uploaded video" do
+    @responses.each do |r|
+      r.file(:md5).size.should eql(32)
+      r.file(:size).to_i.should > 0
+    end
+  end
+end

data/spec/lib/version_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "API call to retrieve version" do
+  it_should_behave_like "Successful response"
+  
+  before do
+    @responses = []
+    @responses << BitsOnTheRun::call('version')
+  end
+  
+  it "should contain information about API current version" do
+    @responses.each do |r|
+      r.version.should be_instance_of String
+    end
+  end
+end

data/spec/shared_specs.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+shared_examples_for "Successful response" do
+  it "should contain status attribute with value #ok" do
+    @responses.each do |r|
+      r.status.should eql("ok")
+      r.ok?.should be_true
+      r.error?.should be_false
+    end
+  end
+end
+
+shared_examples_for "Error response" do
+  it "should contain status attribute with value #error" do
+    @responses.each do |r|
+      r.status.should eql("error")
+      r.ok?.should be_false
+      r.error?.should be_true
+      r.code.should_not be_nil
+      r.title.should_not be_nil
+      r.message.should_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'bitsontherun'
+require 'shared_specs'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end
+
+BitsOnTheRun::Configuration.key    = "your api key"
+BitsOnTheRun::Configuration.secret = "your api secret"
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: bitsontherun
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adrian Dulic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 7
+        - 10
+        version: 0.7.10
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 0
+        - 10
+        version: 1.0.10
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
+description: BitsOnTheRun.com API implementation in Ruby
+email: 
+- adulic@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bitsontherun.gemspec
+- lib/bitsontherun.rb
+- lib/bitsontherun/api.rb
+- lib/bitsontherun/call.rb
+- lib/bitsontherun/configuration.rb
+- lib/bitsontherun/parser.rb
+- lib/bitsontherun/response.rb
+- lib/bitsontherun/store.rb
+- lib/bitsontherun/version.rb
+- spec/lib/account_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/delete_spec.rb
+- spec/lib/error_spec.rb
+- spec/lib/parse_spec.rb
+- spec/lib/store_spec.rb
+- spec/lib/version_spec.rb
+- spec/shared_specs.rb
+- spec/spec_helper.rb
+- spec/test.mp4
+has_rdoc: true
+homepage: http://github.com/adriandulic/bitsontherun
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: bitsontherun
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: BitsOnTheRun.com API implementation in Ruby
+test_files: []
+