bitsontherun 0.0.1 → 0.0.2

data/.gitignore

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

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Adrian Dulic
+Copyright (c) 2010 Adrian Dulić
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.md → README.markdown}

@@ -1,30 +1,40 @@
 BitsOnTheRun
-==============
+============
 
-BitsOnTheRun is an implementation of [bitsontherun.com](bitsontherun.com) API in Ruby.
+BitsOnTheRun is an implementation of [bitsontherun.com](http://bitsontherun.com) API in Ruby.
 
 ## Install
 
-Gemfile:
+Just run the following command:
 
-    gem 'bitsontherun', :git => 'http://github.com/adriandulic/bitsontherun.git'
+    gem install bitsontherun
 
-Setup:
+Then in your Gemfile add the following line:
 
-    BitsOnTheRun::Configuration.key = "your api key"
-    BitsOnTheRun::Configuration.secret = "your api secret"
+    gem 'bitsontherun'
+
+And finally run:
+
+    bundle install
+
+For rails app create the _config/initializers/bitsontherun.rb_ file:
+
+    # Bitsonthrun configuration
+    BitsOnTheRun.key = "your api key"
+    BitsOnTheRun.secret = "your api secret"
 
 ## Usage
 
-Basic:
+Basic call:
 
     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:
+Basic store:
+
+    BitsOnTheRun::store('videos/create', 'video.mp4') => {:status => "ok", ...}
+
+Extended call methods:
 
     call = BitsOnTheRun::API.new(:call)
     call.method('videos/list')
@@ -38,6 +48,8 @@ Extended:
     call.method('videos/update', :video_key => 'your video key', :title => 'New title for video')
     call.execute
     
+Extended store methods:
+
     call = BitsOnTheRun::API.new(:store)
     call.method('videos/create')
     call.file('video.mp4')

data/bitsontherun.gemspec

@@ -1,26 +1,30 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path("../lib/bitsontherun/version", __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
+require "bitsontherun/version"
 
 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.authors     = ["Adrian Dulić"]
+  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.summary     = %q{BitsOnTheRun.com API implementation in Ruby}
+  s.description = %q{BitsOnTheRun.com API implementation in Ruby}
+
+  s.extra_rdoc_files = ["LICENSE", "README.markdown"]
+
   s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project         = "bitsontherun"
-  
+  s.rubyforge_project = s.name
+
   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'
+  s.add_development_dependency "rspec", "2.5.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end

data/lib/bitsontherun.rb

@@ -13,7 +13,9 @@ module BitsOnTheRun
   autoload :Store,          "bitsontherun/store"
   autoload :Response,       "bitsontherun/response"
   autoload :Parser,         "bitsontherun/parser"
-  
+
+  extend Configuration
+
   class Base
     def initialize
       @params = {}
@@ -37,7 +39,7 @@ module BitsOnTheRun
       
       def build_signature
         signature = escape_params
-        Digest::SHA1.hexdigest(signature + Configuration.secret)
+        Digest::SHA1.hexdigest(signature + BitsOnTheRun.secret)
       end
       
       def escape_params
@@ -60,5 +62,9 @@ module BitsOnTheRun
       adapter.file(filename)
       adapter.execute
     end
+
+    def configure
+      yield self if block_given?
+    end
   end
 end

data/lib/bitsontherun/api.rb

@@ -6,13 +6,13 @@ module BitsOnTheRun
     
     def method(method, params = {})
       if params.include?(:api_format)
-        raise ArgumentError("Params hash should not include :api_format, use BitsOnTheRun::Configuration.format instead")
+        raise ArgumentError("Params hash should not include :api_format")
       end
       if params.include?(:api_key)
-        raise ArgumentError("Params hash should not include :api_key, use BitsOnTheRun::Configuration.key instead")
+        raise ArgumentError("Params hash should not include :api_key, use BitsOnTheRun.key instead")
       end
       if params.include?(:api_secret)
-        raise ArgumentError("Params hash should not include :api_secret, use BitsOnTheRun::Configuration.secret instead")
+        raise ArgumentError("Params hash should not include :api_secret, use BitsOnTheRun.secret instead")
       end
       @adapter.method(method, params)
     end

data/lib/bitsontherun/call.rb

@@ -7,8 +7,8 @@ module BitsOnTheRun
       @defaults = {
         :api_nonce => "%08d" % rand(99999999),
         :api_timestamp => Time.now.to_i,
-        :api_key => Configuration.key,
-        :api_format => Configuration.format,
+        :api_key => BitsOnTheRun.key,
+        :api_format => BitsOnTheRun.format,
         :api_kit => "ruby-%s" % VERSION
       }
       super

data/lib/bitsontherun/configuration.rb

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

data/lib/bitsontherun/store.rb

@@ -3,7 +3,7 @@ module BitsOnTheRun
     def initialize
       @response = nil
       @defaults = {
-        :api_format => Configuration.format
+        :api_format => BitsOnTheRun.format
       }
       super
     end

data/lib/bitsontherun/version.rb

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

data/spec/lib/account_spec.rb

@@ -5,10 +5,10 @@ describe "API call to retrieve account" do
   
   before do
     @responses = []
-    @responses << BitsOnTheRun::call('accounts/show', :account_key => BitsOnTheRun::Configuration.key)
+    @responses << BitsOnTheRun::call('accounts/show', :account_key => BitsOnTheRun.key)
     
     @manual = BitsOnTheRun::API.new(:call)
-    @manual.method('accounts/show', :account_key => BitsOnTheRun::Configuration.key)
+    @manual.method('accounts/show', :account_key => BitsOnTheRun.key)
     @responses << @manual.execute
   end
   

data/spec/lib/configuration_spec.rb

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

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: bitsontherun
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
-- Adrian Dulic
+- "Adrian Duli\xC4\x87"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +01:00
+date: 2011-02-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,12 +74,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 27
         segments: 
         - 2
-        - 4
+        - 5
         - 0
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   version_requirements: *id004
 description: BitsOnTheRun.com API implementation in Ruby
@@ -89,15 +89,15 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
 files: 
 - .gitignore
-- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.md
+- README.markdown
 - Rakefile
 - bitsontherun.gemspec
 - lib/bitsontherun.rb

data/.rspec

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