thounds 0.0.1

data/lib/thounds/configuration.rb

@@ -0,0 +1,93 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module Thounds
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Thounds::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :consumer_key,
+      :consumer_secret,
+      :endpoint,
+      :format,
+      :oauth_token,
+      :oauth_token_secret,
+      :proxy,
+      :user_agent].freeze
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [
+      :json,
+      :xml].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application key
+    DEFAULT_CONSUMER_KEY = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CONSUMER_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note This is configurable in case you want to use HTTP instead of HTTPS, specify a different API version, or use a Thounds-compatible endpoint.
+    DEFAULT_ENDPOINT = 'http://thounds.local:3000/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is preferred over XML because it is more concise and faster to parse.
+    DEFAULT_FORMAT = :json
+
+    # By default, don't set a user oauth token
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # By default, don't set a user oauth secret
+    DEFAULT_OAUTH_TOKEN_SECRET = nil
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Thounds Ruby Gem #{Thounds::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.consumer_key       = DEFAULT_CONSUMER_KEY
+      self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+  end
+end

data/lib/thounds/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Thounds
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {'Accept' => "application/#{format}", 'User-Agent' => user_agent},
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => api_endpoint,
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::Multipart
+        connection.use Faraday::Request::OAuth, authentication if authenticated?
+        connection.adapter(adapter)
+        connection.use Faraday::Response::RaiseHttp5xx
+        unless raw
+          case format.to_s.downcase
+          when 'json' then connection.use Faraday::Response::ParseJson
+          when 'xml' then connection.use Faraday::Response::ParseXml
+          end
+        end
+        connection.use Faraday::Response::RaiseHttp4xx
+        connection.use Faraday::Response::Mashify unless raw
+      end
+    end
+  end
+end

data/lib/thounds/error.rb

@@ -0,0 +1,28 @@
+module Thounds
+  # Custom error class for rescuing from all Thounds errors
+  class Error < StandardError; end
+
+  # Raised when Thounds returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Thounds returns the HTTP status code 401
+  class Unauthorized < Error; end
+
+  # Raised when Thounds returns the HTTP status code 403
+  class Forbidden < Error; end
+
+  # Raised when Thounds returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Thounds returns the HTTP status code 406
+  class NotAcceptable < Error; end
+
+  # Raised when Thounds returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Thounds returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Thounds returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+end

data/lib/thounds/request.rb

@@ -0,0 +1,24 @@
+module Thounds
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP request
+    def request(method, path, options={}, raw=false)
+      response = connection(raw).send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(formatted_path(path), options)
+        when :post, :put
+          request.path = formatted_path(path)
+          request.body = options unless options.empty?
+        end
+      end
+      raw ? response : response.body
+    end
+    
+    private
+
+    def formatted_path(path)
+      path
+    end
+  end
+end

data/lib/thounds/version.rb

@@ -0,0 +1,4 @@
+module Thounds
+  # The version of the gem
+  VERSION = '0.0.1'.freeze unless defined?(::Thounds::VERSION)
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Faraday::Response do
+  before do
+    @client = Thounds::Client.new
+  end
+
+  {
+    400 => Thounds::BadRequest,
+    401 => Thounds::Unauthorized,
+    403 => Thounds::Forbidden,
+    404 => Thounds::NotFound,
+    406 => Thounds::NotAcceptable,
+    500 => Thounds::InternalServerError,
+    502 => Thounds::BadGateway,
+    503 => Thounds::ServiceUnavailable,
+  }.each do |status, exception|
+    context "when HTTP status is #{status}" do
+
+      before do
+        stub_get('users/171').to_return(:status => status)
+      end
+
+      it "should raise #{exception.name} error" do
+        lambda do
+          @client.users(171) {|user| user}
+        end.should raise_error(exception)
+      end
+    end
+  end
+end

data/spec/fixtures/user_31.js

@@ -0,0 +1 @@
+{"friend_of_mine":true,"blog_url":null,"created_at":"2009-06-30T09:52:15Z","city":"30027","friendship_id":2914,"profile_url":"smashing","about":null,"avatar":"http://gravatar.com/avatar/8e6e5c47e1d1b87a322fd2bac7f09d2e.png?d=http%3A%2F%2Fthounds.com%2Fimages%2Favatar-big.jpg&r=PG&s=77","country":"Italy","default_thound":{"privacy":"contacts","public_url":"http://thounds.local:3000/t/6245c9","created_at":"2009-07-24T13:08:08Z","bpm":60,"video":false,"lead_track_id":961,"comments_count":0,"mix_url":"http://thounds.local:3000/thounds/611/stream","user_id":31,"plays_count":6,"mix_duration":0,"tracks":[{"title":"Smash Vs. Fraioli from http://www.randomthink.net/labs/html5drums/","duration":0,"created_at":"2009-07-24T13:08:08Z","privacy":"contacts","offset":0,"path":"thounds/611/tracks/961.mp3","uri":"http://thounds.local:3000/tracks/961/stream","youtube_id":null,"thound_id":611,"lat":null,"user_id":31,"host":"s3","lng":null,"delay":0,"cover":null,"id":961,"user":{"city":"30027","avatar":"http://gravatar.com/avatar/8e6e5c47e1d1b87a322fd2bac7f09d2e.png?d=http%3A%2F%2Fwww.thounds.com%2Fimages%2Favatar-big.jpg&r=PG&s=77","country":"Italy","name":"Smash","id":31},"tags":"drum"},{"title":"yo!","duration":0,"created_at":"2010-04-01T08:17:49Z","privacy":"contacts","offset":133,"path":"/mp3/thound_user_171_mix_thound_611_1270109855794.mp3","uri":"http://stage.thounds.astrails.com//mp3/thound_user_171_mix_thound_611_1270109855794.mp3","youtube_id":null,"thound_id":611,"lat":null,"user_id":171,"host":"stage.thounds.astrails.com","lng":null,"delay":0,"cover":null,"id":2223,"user":{"city":"Treviso","avatar":"http://gravatar.com/avatar/5420033d57945e871b468e1a225cb079.png?d=http%3A%2F%2Fwww.thounds.com%2Fimages%2Favatar-big.jpg&r=PG&s=77","country":"Guinea","name":"Giovanni \u3072\u3089\u304c\u306a","id":171},"tags":"ciao"}],"id":611,"tags":"drum ciao","public_id":"6245c9"},"is_new_user":false,"name":"Smash","id":31,"site_url":null,"tags":[]}

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Thounds', 'lib/thounds'
+  add_group 'Faraday Middleware', 'lib/faraday'
+  add_group 'Specs', 'spec'
+end
+
+require File.expand_path('../../lib/thounds', __FILE__)
+
+require 'rspec'
+require 'webmock/rspec'
+RSpec.configure do |config|
+  config.include WebMock::API
+end
+
+def a_delete(path)
+  a_request(:delete, Thounds.endpoint + path)
+end
+
+def a_get(path)
+  a_request(:get, Thounds.endpoint + path)
+end
+
+def a_post(path)
+  a_request(:post, Thounds.endpoint + path)
+end
+
+def a_put(path)
+  a_request(:put, Thounds.endpoint + path)
+end
+
+def stub_delete(path)
+  stub_request(:delete, Thounds.endpoint + path)
+end
+
+def stub_get(path)
+  stub_request(:get, Thounds.endpoint + path)
+end
+
+def stub_post(path)
+  stub_request(:post, Thounds.endpoint + path)
+end
+
+def stub_put(path)
+  stub_request(:put, Thounds.endpoint + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/thounds/api_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Thounds::API do
+  before do
+    @keys = Thounds::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  context "with module configuration" do
+
+    before do
+      Thounds.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Thounds.reset
+    end
+
+    it "should inherit module configuration" do
+      api = Thounds::API.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :consumer_key => 'CK',
+          :consumer_secret => 'CS',
+          :oauth_token => 'OT',
+          :oauth_token_secret => 'OS',
+          :adapter => :typhoeus,
+          :endpoint => 'http://tumblr.com/',
+          :format => :xml,
+          :proxy => 'http://giovanni:secret@proxy.example.com:8080',
+          :user_agent => 'Custom User Agent',
+        }
+      end
+
+      context "during initialization"
+
+        it "should override module configuration" do
+          api = Thounds::API.new(@configuration)
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+
+      context "after initilization" do
+
+        it "should override module configuration after initialization" do
+          api = Thounds::API.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/thounds/client_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Thounds::Client do
+  it "should connect using the endpoint configuration" do
+    client = Thounds::Client.new
+    endpoint = URI.parse(client.api_endpoint)
+    connection = client.send(:connection).build_url(nil).to_s
+    connection.should == endpoint.to_s
+  end
+end

data/spec/thounds_spec.rb

@@ -0,0 +1,358 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Thounds do
+  after do
+    Thounds.reset
+  end
+
+  context "when delegating to a client" do
+
+    before do
+      stub_get("users/31").
+        to_return(:body => fixture("user_31.js"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      Thounds.users(31) {|user| user}
+      a_get("users/31").
+        should have_been_made
+    end
+
+    it "should return the same results as a client" do
+      class_obj = nil
+      client_obj = nil
+      
+      Thounds.users(31) {|user| class_obj = user}
+      Thounds::Client.new.users(31) {|user| client_obj = user}
+      
+      class_obj.should == client_obj
+    end
+
+  end
+  
+  context "when making a request to" do
+    
+    # http://developers.thounds.com/API/HomeStream
+    describe "GET home" do
+      before do
+        stub_get("home")
+      end
+      
+      it "should use 'home' request path" do
+        Thounds.home {|r| r}.proxy.path.should == "home"
+      end
+    end
+    
+    # http://developers.thounds.com/API/UserMetadata
+    describe "GET profile" do
+      before do
+        stub_get("profile")
+      end
+      
+      it "should use 'profile' request path" do
+        Thounds.profile {|r| r}.proxy.path.should == "profile"
+      end
+    end
+    
+    # http://developers.thounds.com/API/UserMetadata
+    describe "GET users/123" do
+      before do
+        stub_get("users/123")
+      end
+      
+      it "should use 'users/123' request path" do
+        Thounds.users(123) {|r| r}.proxy.path.should == "users/123"
+      end
+    end
+    
+    # http://developers.thounds.com/API/UserBand
+    # http://developers.thounds.com/API/UserLibrary
+    # http://developers.thounds.com/API/UserNotifications
+    ["band", "library", "notifications"].each do |member|
+      describe "GET profile/#{member}" do
+        before do
+          stub_get("profile/#{member}")
+        end
+
+        it "should use 'profile/#{member}' request path" do
+          Thounds.profile.send(member) {|r| r}.proxy.path.should == "profile/#{member}"
+        end
+      end
+    end
+    
+    # http://developers.thounds.com/API/UserBand
+    # http://developers.thounds.com/API/UserLibrary
+    ["band", "library"].each do |member|
+      describe "GET users/123/#{member}" do
+        before do
+          stub_get("users/123/#{member}")
+        end
+
+        it "should use 'users/123/#{member}' request path" do
+          Thounds.users(123).send(member) {|r| r}.proxy.path.should == "users/123/#{member}"
+        end
+      end
+    end
+    
+    # http://developers.thounds.com/API/UserRegistration
+    describe "POST users" do
+      before do
+        stub_post("users")
+        
+        @options = {
+          :user => {
+            :name => "John Doe",
+            :email => "john@doe.com",
+            :country => "Italy",
+            :city => "Roma",
+            :tags => "jazz vocal"
+          }
+        }
+        @request = Thounds.users.post(@options) {|r| r}
+      end
+      
+      it "should use 'users' request path" do
+        @request.proxy.path.should == "users"
+      end
+      
+      it "should use POST request verb" do
+        @request.proxy.verb.should == :post
+      end
+      
+      it "should include new user parameters into request" do
+        @request.proxy.options.should == @options
+      end
+    end
+    
+    # http://developers.thounds.com/API/FriendshipRequest
+    describe "POST users/123/friendships" do
+      before do
+        stub_post("users/123/friendships")
+        
+        @request = Thounds.users(123).friendships.post {|r| r}
+      end
+      
+      it "should use 'users/123/friendships' request path" do
+        @request.proxy.path.should == "users/123/friendships"
+      end
+      
+      it "should use POST request verb" do
+        @request.proxy.verb.should == :post
+      end
+    end
+    
+    # http://developers.thounds.com/API/FriendshipAcceptRefuse
+    # http://developers.thounds.com/API/FriendshipDelete
+    [:put, :delete].each do |verb|
+      describe "#{verb.to_s.upcase} profile/friendships/123" do
+        before do
+          send("stub_#{verb}", "profile/friendships/123")
+
+          @request = Thounds.profile.friendships(123).send(verb) {|r| r}
+        end
+
+        it "should use 'profile/friendships/123' request path" do
+          @request.proxy.path.should == "profile/friendships/123"
+        end
+
+        it "should use #{verb.to_s.upcase} request verb" do
+          @request.proxy.verb.should == verb
+        end
+      end
+    end
+    
+    # http://developers.thounds.com/API/ThoundMetadata
+    # http://developers.thounds.com/API/ThoundDelete
+    [:get, :delete].each do |verb|
+      describe "#{verb.to_s.upcase} thounds/123" do
+        before do
+          send("stub_#{verb}", "thounds/123")
+
+          @request = Thounds.thounds(123).send(verb) {|r| r}
+        end
+
+        it "should use 'thounds/123' request path" do
+          @request.proxy.path.should == "thounds/123"
+        end
+
+        it "should use #{verb.to_s.upcase} request verb" do
+          @request.proxy.verb.should == verb
+        end
+      end
+    end
+    
+    # http://developers.thounds.com/API/ThoundPublicStream
+    describe "GET thounds/public_stream" do
+      before do
+        stub_get("thounds/public_stream")
+      end
+      
+      it "should use 'thounds/public_stream' request path" do
+        Thounds.thounds.public_stream {|r| r}.proxy.path.should == "thounds/public_stream"
+      end
+    end
+    
+    # http://developers.thounds.com/API/ThoundSearch
+    describe "GET thounds/search" do
+      before do
+        stub_get("thounds/search?q=query")
+        
+        @options = {:q => "query"}
+        @request = Thounds.thounds.search(@options) {|r| r}
+      end
+
+      it "should use 'thounds/search' request path" do
+        @request.proxy.path.should == "thounds/search"
+      end
+      
+      it "should include new user parameters into request" do
+        @request.proxy.options.should == @options
+      end
+    end
+    
+    # http://developers.thounds.com/API/TrackCreate
+    # http://developers.thounds.com/API/ThoundCreate
+    describe "POST tracks" do
+      before do
+        stub_post("tracks")
+        
+        @options = {
+          :track => {
+            :delay => 0,
+            :offset => 0,
+            :duration => 0,
+            :lat => 45.4375,
+            :lng => 12.3358,
+            :title => "My new default thound!",
+            :privacy => "contacts",
+            :thound_attributes => {
+              :bpm => 90
+            },
+            :tag_list => "vocal jazz",
+            :thoundfile => "SUQzB...",
+            :coverfile => "iVBOR..."
+          }
+        }
+        @request = Thounds.tracks.post(@options) {|r| r}
+      end
+      
+      it "should use 'tracks' request path" do
+        @request.proxy.path.should == "tracks"
+      end
+      
+      it "should use POST request verb" do
+        @request.proxy.verb.should == :post
+      end
+      
+      it "should include new track parameters into request" do
+        @request.proxy.options.should == @options
+      end
+    end
+    
+    # http://developers.thounds.com/API/TrackDelete
+    describe "DELETE tracks/123" do
+      before do
+        stub_delete("tracks/123")
+        
+        @request = Thounds.tracks(123).delete {|r| r}
+      end
+      
+      it "should use 'tracks/123' request path" do
+        @request.proxy.path.should == "tracks/123"
+      end
+      
+      it "should use DELETE request verb" do
+        @request.proxy.verb.should == :delete
+      end
+    end
+    
+    # http://developers.thounds.com/API/TrackNotificationsDelete
+    describe "DELETE track_notifications/123" do
+      before do
+        stub_delete("track_notifications/123")
+        
+        @request = Thounds.track_notifications(123).delete {|r| r}
+      end
+      
+      it "should use 'track_notifications/123' request path" do
+        @request.proxy.path.should == "track_notifications/123"
+      end
+      
+      it "should use DELETE request verb" do
+        @request.proxy.verb.should == :delete
+      end
+    end
+    
+  end
+
+  describe ".client" do
+    it "should be a Thounds::Client" do
+      Thounds.client.should be_a Thounds::Client
+    end
+  end
+
+  describe ".adapter" do
+    it "should return the default adapter" do
+      Thounds.adapter.should == Thounds::Configuration::DEFAULT_ADAPTER
+    end
+  end
+
+  describe ".adapter=" do
+    it "should set the adapter" do
+      Thounds.adapter = :typhoeus
+      Thounds.adapter.should == :typhoeus
+    end
+  end
+
+  describe ".endpoint" do
+    it "should return the default endpoint" do
+      Thounds.endpoint.should == Thounds::Configuration::DEFAULT_ENDPOINT
+    end
+  end
+
+  describe ".endpoint=" do
+    it "should set the endpoint" do
+      Thounds.endpoint = 'http://tumblr.com/'
+      Thounds.endpoint.should == 'http://tumblr.com/'
+    end
+  end
+
+  describe ".format" do
+    it "should return the default format" do
+      Thounds.format.should == Thounds::Configuration::DEFAULT_FORMAT
+    end
+  end
+
+  describe ".format=" do
+    it "should set the format" do
+      Thounds.format = 'xml'
+      Thounds.format.should == 'xml'
+    end
+  end
+
+  describe ".user_agent" do
+    it "should return the default user agent" do
+      Thounds.user_agent.should == Thounds::Configuration::DEFAULT_USER_AGENT
+    end
+  end
+
+  describe ".user_agent=" do
+    it "should set the user_agent" do
+      Thounds.user_agent = 'Custom User Agent'
+      Thounds.user_agent.should == 'Custom User Agent'
+    end
+  end
+
+  describe ".configure" do
+
+    Thounds::Configuration::VALID_OPTIONS_KEYS.each do |key|
+
+      it "should set the #{key}" do
+        Thounds.configure do |config|
+          config.send("#{key}=", key)
+          Thounds.send(key).should == key
+        end
+      end
+    end
+  end
+end