officialfm 0.1.2 → 0.2.0

data/lib/officialfm/projects.rb

@@ -0,0 +1,65 @@
+module OfficialFM
+  module Projects
+
+    # Search for a project
+    def projects(search_param, options={})
+      response = connection.get '/projects/search', options.merge(:q => search_param)
+
+      response.body.projects.map! do |p|
+        # remove the unnecessary root
+        actual_project = p.project
+
+        extend_response(actual_project, ProjectMethods)
+
+        actual_project
+      end
+
+      response.body
+    end
+
+    # Retrieve information about a specific project
+    def project(id, options={})
+      url = resource_url(id, parent: 'projects')
+
+      response = connection.get(url, options).body.project
+      extend_response(response, ProjectMethods)
+    end
+
+    def project_playlists(id, options={})
+      url = resource_url(id, { parent: 'projects', child: 'playlists' })
+
+      response = connection.get url, options
+
+      playlists = response.body.playlists.map do |p|
+        # remove the unnecessary root
+        p.playlist
+      end
+
+      playlists
+    end
+
+    def project_tracks(id, options={})
+      url = resource_url(id, { parent: 'projects', child: 'tracks' })
+
+      response = connection.get url, options
+
+      tracks = response.body.tracks.map do |t|
+        # remove the unnecessary root
+        t.track
+      end
+
+      tracks
+    end
+
+    module ProjectMethods
+      def playlists
+        obj.project_playlists(self.src)
+      end
+
+      def tracks
+        obj.project_tracks(self.src)
+      end
+    end
+
+  end
+end

data/lib/officialfm/tracks.rb

@@ -1,206 +1,24 @@
-require 'cgi'
-
 module OfficialFM
   module Tracks
-  
+
     # Search for tracks
-    #
-    # @param [String] search_param: a search parameter (eg. name of the track)
-    # @param [Integer] limit (50) limit per page (optional)
-    # @return [Hashie::Mash] Track list
     def tracks(search_param, options={})
-      response = connection.get do |req|
-        req.url "/search/tracks/#{CGI::escape(search_param)}", simple_params(options)
-      end
-      response.body
-    end
-  
-    # Retrieve information about a specific track
-    #
-    # Note: http://official.fm/developers/simple_api#track_show
-    # says that api_max_responses is a valid parameter. Why escapes me.
-    #
-    # @param [String] track_id: id
-    # @param [Bool] embed (false) should embed codes be included in the response
-    # @return [Hashie::Mash] Track
-    def track(track_id, options={})
-      response = connection.get do |req|
-        req.url "/track/#{track_id}", simple_params(options)
-      end
-      response.body[0]
-    end
-    
-    # Retrieve users that have voted for this track
-    #
-    # @param [String] track_id: id
-    # @param [Integer] limit (50) limit per page
-    # @return [Hashie::Mash] User list
-    def track_votes(track_id, options={})
-      response = connection.get do |req|
-        req.url "/track/#{track_id}/votes", simple_params(options)
-      end
-      response.body
-    end
-    
-    # Retrieve 200 tracks of selected chart
-    #
-    # @param [String] charting: :today, :week, :month, :year or :all_time
-    # @param [String] genre: Genre string (Electronic, Rock, Jazz, ...) (optional)
-    # @param [String] country: ISO country id (CH, FR, UK) (optional)
-    # @param [Bool] embed (false) should embed codes be included in the response (optional)
-    # @param [Integer] limit (200) limit per page (optional)
-    # @return [Hashie::Mash] Track list
-    def charts(charting, options={})
-      response = connection.get do |req|
-        req.url "/tracks/charts", simple_params(options)
-      end
-      response.body
-    end
-    
-    # Retrieve 200 latest tracks
-    #
-    # @param [String] genre: Genre string (Electronic, Rock, Jazz, ...) (optional)
-    # @param [String] country: ISO country id (CH, FR, UK) (optional)
-    # @param [Bool] embed (false) should embed codes be included in the response (optional)
-    # @param [Integer] limit (200) limit per page (optional)
-    # @return [Hashie::Mash] Track list
-    def latest(options={})
-      response = connection.get do |req|
-        req.url "/tracks/latest", simple_params(options)
-      end
-      response.body
-    end
-    
-    ####################################################################
-    ######################### Advanced API methods #####################
-    ####################################################################
+      response = connection.get '/tracks/search', options.merge(:q => search_param)
 
-    # Update information of a given track
-    #
-    # @param [String] track_id: id
-    # @param [String] artist_name (optional)
-    # @param [String] buy_url (optional)
-    # @param [String] country_id (optional)
-    # @param [String] downloadable (optional)
-    # @param [String] derived_by (optional)
-    # @param [String] derived_type (optional)
-    # @param [String] description (optional)
-    # @param [String] isrc (optional)
-    # @param [String] label_name (optional)
-    # @param [String] label_none (optional)
-    # @param [String] license_type (optional)
-    # @param [String] lyrics (optional)
-    # @param [String] genre_string (optional)
-    # @param [String] original_track_id (optional)
-    # @param [String] password (optional)
-    # @param [String] pr_url (optional)
-    # @param [String] private (optional)
-    # @param [String] require_valid_email (optional)
-    # @param [String] tag_string (optional)
-    # @param [String] title (optional)
-    # @param [String] url_1_name (optional)
-    # @param [String] url_1 (optional)
-    # @param [String] url_2_name (optional)
-    # @param [String] url_2 (optional)
-    # @param [String] web_url (optional)
-    # @return [Hashie::Mash] Track
-    def update_track! (track_id, data = {})
-      check_auth :update_track
-    
-      response = connection.put do |req|
-        req.url "/track/update/#{track_id}", data
-        req.body = { :format => @format }
-      end
-      response
-    end
-    
-    # Upload a picture for a given track
-    #
-    # @param [String] track_id: id
-    # @param [String] path: path to a picture
-    # @param [String] mime: the mime-type of the picture (e.g. image/jpeg, image/png, etc.)
-    # @return [Hashie::Mash] Success or error message
-    def track_picture! (track_id, path, mime)
-      check_auth :track_picture
-    
-      response = connection.post  do |req|
-        req.url "/track/picture/#{track_id}"
-        req.body = { :file => Faraday::UploadIO.new(path, mime), :format => @format }
-      end
-      response
-    end
-    
-    # Vote for a track
-    #
-    # @param [String] track_id: id
-    # @return [Hashie::Mash] Success or error message
-    def track_vote! (track_id)
-      check_auth :track_vote
-    
-      response = connection.post  do |req|
-        req.url "/track/vote/#{track_id}"
-        req.body = { :format => @format }
+      response.body.tracks.map! do |t|
+        # remove useless root
+        t.track
       end
-      response
-    end
 
-    # Remove vote for a track
-    #
-    # @param [String] track_id: id
-    # @return [Hashie::Mash] Success or error message
-    def track_unvote! (track_id)
-      check_auth :track_unvote
-    
-      response = connection.post  do |req|
-        req.url "/track/unvote/#{track_id}"
-        req.body = { :format => @format }
-      end
-      response
-    end
-    
-    # Add a track to a playlist
-    #
-    # @param [String] track_id: id
-    # @param [String] playlist_id: id
-    # @return [Hashie::Mash] Success or error message
-    def add_track_to_playlist! (track_id, playlist_id)
-      check_auth :add_track_to_playlist!
-    
-      response = connection.post  do |req|
-        req.url "/track/#{track_id}/addto/#{playlist_id}"
-        req.body = { :format => @format }
-      end
-      response
+      response.body
     end
 
-    # Remove a track from a playlist
-    #
-    # @param [String] track_id: id
-    # @param [String] playlist_id: id
-    # @return [Hashie::Mash] Success or error message
-    def remove_track_from_playlist! (track_id, playlist_id)
-      check_auth :remove_track_from_playlist!
-    
-      response = connection.delete  do |req|
-        req.url "/track/#{track_id}/removefrom/#{playlist_id}"
-        req.body = { :format => @format }
-      end
-      response
-    end
-    
-    # Upload a new track to Official.fm
-    #
-    # @param [String] path: path to an mp3, 44.1Khz file
-    # @param [String] mime: the mime-type of the file (e.g. audio/mpeg, etc.)
-    # @return [Hashie::Mash] Track
-    def upload! (path, mime)
-      check_auth :upload
-    
-      response = connection.post  do |req|
-        req.url "/track/upload"
-        req.body = { :file => Faraday::UploadIO.new(path, mime), :format => @format }
-      end
-      response
+    # Retrieve information about a specific track
+    def track(id, options={})
+      url = resource_url(id, parent: 'tracks')
+
+      response = connection.get url, options
+      response.body.track
     end
 
   end

data/lib/officialfm/version.rb

@@ -1,3 +1,3 @@
 module OfficialFM
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/officialfm.rb

@@ -7,24 +7,18 @@ module OfficialFM
 
   class << self
     attr_accessor :api_key
-    attr_accessor :api_secret
-    attr_accessor :test_mode
 
     # Configures default credentials easily
-    # @yield [api_key, username, password]
+    # @yield api_key
     def configure
       yield self
       true
     end
-
-    def test_mode?
-      !!self.test_mode
-    end
   end
 
-  require 'officialfm/users'
   require 'officialfm/tracks'
   require 'officialfm/playlists'
+  require 'officialfm/projects'
   require 'officialfm/client'
 
 end

data/officialfm.gemspec

@@ -4,34 +4,28 @@ require File.expand_path('../lib/officialfm/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.name = 'officialfm'
   gem.version = OfficialFM::VERSION
-  gem.authors = ["Amos Wenger"]
-  gem.email = ['amos@official.fm']
-  gem.summary = %q{Official Ruby bindings for the official.fm API}
-  gem.description = %q{Official Ruby bindings for the official.fm API}
+  gem.authors = ["Dimiter Petrov"]
+  gem.email = ['dimiter@official.fm']
+  gem.summary = %q{Official Ruby bindings for the official.fm v2 API}
+  gem.description = %q{Official Ruby bindings for the official.fm v2 API}
   gem.post_install_message =<<eos
 ********************************************************************************
 
   Follow @ofmdev on Twitter for announcements, updates, and news.
   https://twitter.com/ofmdev
 
-  Don't forget to get your API key here:
-  http://official.fm/developers/manager
-
 ********************************************************************************
 eos
-  gem.homepage = 'http://github.com/officialfm/officialfm-ruby'
-
-  gem.add_runtime_dependency 'faraday', '~> 0.6'
-  gem.add_runtime_dependency 'faraday_middleware', '~> 0.6'
-  gem.add_runtime_dependency 'hashie', '~> 1.0'
-  gem.add_runtime_dependency 'simple_oauth', '~> 0.1.5'
+  gem.homepage = 'http://github.com/officialfm/officialfm-v2-ruby'
 
+  gem.add_runtime_dependency 'faraday', '~> 0.8.1'
+  gem.add_runtime_dependency 'faraday_middleware', '~> 0.8.8'
+  gem.add_runtime_dependency 'hashie', '~> 1.2'
+  
   gem.add_development_dependency 'bundler', '~> 1.0'
-  gem.add_development_dependency 'fakeweb', '~> 1.3'
-  gem.add_development_dependency 'jnunemaker-matchy', '~> 0.4'
-  gem.add_development_dependency 'json_pure', '~> 1.5'
   gem.add_development_dependency 'rake', '~> 0.8'
   gem.add_development_dependency 'shoulda', '~> 2.11'
+  gem.add_development_dependency 'jnunemaker-matchy', '~> 0.4'
   gem.add_development_dependency 'test-unit', '~> 2.1'
 
   gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if gem.respond_to? :required_rubygems_version=

data/test/client_test.rb

@@ -0,0 +1,97 @@
+require 'helper'
+
+class ClientTest < Test::Unit::TestCase
+
+  context "OfficialFM::Client" do
+
+    should "use the configuration set with OfficialFM.configure by default" do
+      API_KEY = "test key"
+
+      OfficialFM.configure do |s|
+        s.api_key = API_KEY
+      end
+
+      OfficialFM.api_key.should == API_KEY
+      OfficialFM::Client.new.api_key.should == API_KEY
+    end
+
+
+    should "be able to override the default configuration" do
+      DEFAULT_API_KEY = "test key"
+      CUSTOM_API_KEY = "other test key"
+
+      OfficialFM.configure do |s|
+        s.api_key = DEFAULT_API_KEY
+      end
+
+      client = OfficialFM::Client.new(:api_key => CUSTOM_API_KEY)
+      client.api_key.should == CUSTOM_API_KEY
+
+    end
+
+    context "#resource_url" do
+      setup do
+        @base_url = 'http://example.com'
+        @client = OfficialFM::Client.new
+      end
+
+      should "not change the base paths of complete URLs" do
+        options = {
+          parent: 'foo',
+          child:  'bar'
+        }
+
+        @client.send(:resource_url, @base_url, options).start_with?(@base_url).should be(true)
+      end
+
+      should "build resource url from a base url" do
+        options = {
+          parent: 'foo',
+          child:  'bar'
+        }
+
+        @client.send(:resource_url, @base_url, options).should == 'http://example.com/bar'
+      end
+
+      should "build resource url from an id" do
+        options = {
+          parent: 'foo',
+          child:  'bar'
+        }
+        @client.send(:resource_url, '42', options).should == '/foo/42/bar'
+      end
+
+      should "build url for resource without child" do
+        @client.send(:resource_url, '42', parent: 'foo').should == '/foo/42'
+      end
+
+      should "build url for resource without parent" do
+        @client.send(:resource_url, 'user', child: 'profile').should == '/user/profile'
+      end
+
+      should "build url for resource without parent or child" do
+        @client.send(:resource_url, 'greeting').should == '/greeting'
+      end
+
+      should "raise an error when resource id is nil" do
+        lambda {@client.send(:resource_url, nil)}.should raise_error
+      end
+    end
+
+    context "#extend_response" do
+      setup do
+        @client = OfficialFM::Client.new
+      end
+
+      should "add module methods to a client response object" do
+        response = Hashie::Mash.new
+        module CustomMethods; def foo; end; end
+
+        @client.send(:extend_response, response, CustomMethods).should respond_to? :foo
+      end
+
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -1,42 +1,16 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'matchy'
-require 'fakeweb'
-begin require 'redgreen'; rescue LoadError; end
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-gem-adapter'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'officialfm'
-
-FakeWeb.allow_net_connect = false
-
-def officialfm_test_client
-  OfficialFM::Client.new(:api_key => 'GNXbH3zYb25F1I7KVEEN')
+  SimpleCov.start 'gem'
 end
 
-def fixture_file(filename)
-  return '' if filename == ''
-  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
-  File.read(file_path)
-end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 
-def officialfm_url(url)
-  url =~ /^http/ ? url : "http://api.official.fm#{url}"
-end
+require 'officialfm'
 
-def stub_get(url, filename, options={})
-  opts = {
-    :body => fixture_file(filename),
-    :content_type => 'application/json; charset=utf-8'
-  }.merge(options)
-  FakeWeb.register_uri(:get, officialfm_url(url), opts)
-end
+require 'test/unit'
+require 'shoulda'
+require 'matchy'
 
-def stub_post(url, filename, options={})
-  opts = {
-    :body => fixture_file(filename),
-    :content_type => 'application/json; charset=utf-8'
-  }.merge(options)
-  FakeWeb.register_uri(:post, officialfm_url(url), opts)
-end

data/test/tracks_test.rb

@@ -1,48 +1,27 @@
 require 'helper'
 
 class TracksTest < Test::Unit::TestCase
+  context "OfficialFM::Client" do
 
-  context "When using the official.fm API and working with Tracks" do
     setup do
-      @client = officialfm_test_client
-    end
-    
-    should "search for 5 tracks with the 'Quelque Chose' search term" do
-      stub_get('http://api.official.fm/search/tracks/Quelque+Chose?key=GNXbH3zYb25F1I7KVEEN&format=json&api_max_responses=5', 'tracks.json')
-      tracks = @client.tracks('Quelque Chose', :limit => 5)
-      tracks.length.should == 5
-      tracks[0].artist_string.should == 'Radio Sympa'
-      tracks[4].title.should == 'Manhattan'
-      # interestingly, the search turns up nothing about QuelqueChoseD'HasBeen :/
-    end
-    
-    should "look up informations about my favorite SomethingALaMode mix" do
-      stub_get('http://api.official.fm/track/60526?key=GNXbH3zYb25F1I7KVEEN&format=json&api_embed_codes=', 'track.json')
-      track = @client.track(60526)
-      # yes, for some reason there's a double-escaped backslash in there. Don't ask, don't tell.
-      track.title.should == "QuelqueChosed\'HasBeen"
-      track.artist_string.should == 'Various Artist'
-    end
-    
-    should "retrieve a list of 3 users who voted for QuelqueChoseD'HasBeen" do
-      stub_get('http://api.official.fm/track/60526/votes?key=GNXbH3zYb25F1I7KVEEN&format=json&api_max_responses=3', 'track_votes.json')
-      users = @client.track_votes(60526, :limit => 3)
-      users[0].city.should == "Geneva"
-      users[1].profile.should == "co-founder @official.fm"
-      users[2].id.should == 7615
+      @client = OfficialFM::Client.new
+
+      @stubs = Faraday::Adapter::Test::Stubs.new
+
+      @client.connection.builder.adapter :test, @stubs
     end
-    
-    should "retrieve 50 latest tracks from the 'electronic' charts" do
-      stub_get('http://api.official.fm/tracks/charts?key=GNXbH3zYb25F1I7KVEEN&format=json&charting=month&genre=&country=&api_embed_codes=&api_max_responses=', 'charts.json')
-      tracks = @client.charts('month')
-      tracks.length.should == 50 # the API's default
+
+    context "#tracks" do
     end
-    
-    should "retrieve 50 last posted tracks" do
-      stub_get('http://api.official.fm/tracks/latest?key=GNXbH3zYb25F1I7KVEEN&format=json&genre=&country=&api_embed_codes=&api_max_responses=', 'charts.json')
-      tracks = @client.latest()
-      tracks.length.should == 50 # the API's default
+
+    context "#track" do
+      should "return a track" do
+        id = 42
+        @stubs.get("/tracks/#{id}") {[200, {}, 'test']}
+        raise "Implement"
+        @client.track(id)
+
+      end
     end
   end
-  
 end