next-big-sound-lite 0.2.0 → 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in next_big_sound_lite.gemspec
+gemspec

data/README.md

@@ -0,0 +1,20 @@
+Next Big Sound Lite
+--
+
+This gem wraps the Next Big Sound JSON API. Read the API docs {here}[http://api3.nextbigsound.com].
+
+Done? Then you can use this API.
+
+First setup the gem to use your API key:
+
+    NextBigSoundLite.api_key = 'my_key'
+    
+If you have a private key (for writing):
+
+    NextBigSoundLite.private_key = 'my_private_key'
+
+The methods of this wrapper are organized in the same way as the subsections of the API docs. For example to call the endpoint 'profile' on Metrics you should call:
+    
+    NextBigSoundLite::Metric.profile(200, :start => 2.months.ago)
+
+Notice that the receiver has a singular name (ala Rails Models)

data/Rakefile

@@ -1,15 +1,9 @@
-# Rakefile
-require 'rubygems'
-require 'rake'
-require 'echoe'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-Echoe.new('next-big-sound-lite', '0.2.0') do |p|
-  p.description    = "Thin wrapper for the Next Big Sound API."
-  p.url            = "http://github.com/rpbertp13/next-big-sound-lite"
-  p.author         = "Roberto Thais"
-  p.email          = "roberto.n.thais@gmail.com"
-  p.ignore_pattern = ["tmp/*", "script/*"]
-  p.development_dependencies = ["rest-client", "json"]
-end
+require 'spec/rake/spectask'
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = Dir.glob('spec/**/*_spec.rb')
+  t.spec_opts << '--format specdoc'
+end

data/lib/next-big-sound-lite.rb

@@ -1,30 +1 @@
-#For version 2.0 of the Next Big Sound API
-
-require 'rest_client'
-require 'json'
-require 'cgi'
-
-require 'next-big-sound-lite/resource'
-require 'next-big-sound-lite/artist'
-require 'next-big-sound-lite/genre'
-require 'next-big-sound-lite/metric'
-require 'next-big-sound-lite/profile'
-require 'next-big-sound-lite/service'
-require 'next-big-sound-lite/track'
-require 'next-big-sound-lite/youtube'
-
-module NBS
-  
-  class << self
-    attr_reader :base
-    attr_accessor :private_key
-  end
-  
-  def self.api_key=(key)
-    @base = RestClient::Resource.new("http://#{key}.api2.nextbigsound.com")
-  end  
-    
-  self.api_key = 'key'
-
-end
-
+require 'next_big_sound_lite'

data/lib/next_big_sound_lite.rb

@@ -0,0 +1,27 @@
+#For version 3.0 of the Next Big Sound API
+
+require 'rest_client'
+require 'json'
+require 'hashie'
+
+require 'next_big_sound_lite/resource'
+require 'next_big_sound_lite/resources/artist'
+require 'next_big_sound_lite/resources/genre'
+require 'next_big_sound_lite/resources/metric'
+require 'next_big_sound_lite/resources/profile'
+require 'next_big_sound_lite/resources/service'
+
+module NextBigSoundLite
+  
+  class << self
+    attr_reader :base
+    attr_accessor :private_key
+  end
+  
+  def self.api_key=(key)
+    @base = RestClient::Resource.new("http://#{key}.api3.nextbigsound.com")
+  end  
+    
+  self.api_key = 'key'
+
+end

data/lib/next_big_sound_lite/resource.rb

@@ -0,0 +1,59 @@
+module  NextBigSoundLite
+  
+  class Resource
+    def self.resource(name)
+      NextBigSoundLite.base[name]
+    end
+    
+    def self.get(resource)
+      begin
+        res = parse resource.get
+        if block_given?
+          yield res
+        else
+          res
+        end
+      # The API uses 400 Bad Request to indicate negative results
+      # such as 'no results found'. 
+      rescue RestClient::BadRequest => e
+        false
+      end      
+    end
+    
+    def self.post(resource, params)
+      begin
+        parse resource.post(params)
+      rescue RestClient::BadRequest => e
+        false
+      end          
+    end
+    
+    def self.parse(response)
+      res = JSON.parse(response)
+      case res
+      when Array
+        if res.first.is_a? Hash
+          res.map { |hash| Hashie::Mash.new hash }
+        else
+          res
+        end
+      when Hash
+        Hashie::Mash.new res
+      else
+        res
+      end
+    end    
+    
+    # Next Big Sound returns some results as hashes with 
+    # keys equal to id of the object and values as the 
+    # relevant data. This creates an array that includes
+    # the id within the object. 
+    def self.idfy(hash)
+      hash.to_a.map do |id, data|
+        data.dup.tap { |d| d.id = id }
+      end
+    end
+    
+  end
+  
+end

data/lib/next_big_sound_lite/resources/artist.rb

@@ -0,0 +1,35 @@
+module NextBigSoundLite
+  
+  class Artist < Resource
+    
+    def self.resource
+      super 'artists'
+    end
+    
+    def self.find(id)
+      get resource["view/#{id}.json"]
+    end
+    class << self; alias :view :find; end
+    
+    def self.search(q)
+      get resource["search.json?q=#{CGI.escape(q)}"] do |response|
+        idfy response
+      end
+    end
+    
+    def self.ranking(type, ids)
+      ids = ids.join('-')
+      get resource["rank/#{type}/#{ids}.json"]
+    end  
+    
+    def self.add(name, profiles)
+      params = {
+        :key => NextBigSoundLite.private_key,
+        :name => name,
+        :profiles => profiles
+      }
+      post resource["add.json"], params
+    end
+  end
+  
+end

data/lib/{next-big-sound-lite → next_big_sound_lite/resources}/genre.rb

@@ -1,4 +1,4 @@
-module NBS
+module NextBigSoundLite
   
   class Genre < Resource
     
@@ -7,8 +7,9 @@ module NBS
     end
     
     def self.artist(id)
-      res = resource["artist/#{id}.json"].get
-      JSON.parse(res)
+      get resource["artist/#{id}.json"] do |response|
+        idfy response
+      end
     end
   end
   

data/lib/next_big_sound_lite/resources/metric.rb

@@ -0,0 +1,49 @@
+module NextBigSoundLite
+  
+  class Metric < Resource
+    
+    ALLOWED_METRICS = %w(all plays fans views comments downloads likes price)
+    
+    def self.resource
+      super 'metrics'
+    end
+    
+    # start and end can be either a Date or Time object
+    def self.profile(id, params = {})
+      get resource["profile/#{id}.json?#{querify params}"]
+    end
+    
+    def self.artist(id, params = {})
+      get resource["artist/#{id}.json?#{querify params}"] do |response|
+        response.map do |metric|
+          Hashie::Mash.new Hash[metric.to_a.map { |k,v| [k.downcase, v] }]
+        end
+      end
+    end
+    
+    private
+    
+      def self.querify(params)
+        params[:start] &&= format_time(params[:start])
+        params[:end] &&= format_time(params[:end])
+        params[:metric] = (ALLOWED_METRICS & [params[:metric]]).first
+        params.to_a.map do |k,v|
+          "#{k}=#{CGI.escape(v)}" if !!v
+        end.compact.join("&")
+      end 
+    
+      def self.format_time(obj)
+        out = case obj
+        when Date
+          Time.local(obj.year, obj.mon, obj.mday)
+        when Time
+          obj
+        else
+          raise ArgumentError, "start/end times need to be Date or Time objects"
+        end
+        out.to_i.to_s
+      end
+    
+  end
+
+end

data/lib/next_big_sound_lite/resources/profile.rb

@@ -0,0 +1,29 @@
+module NextBigSoundLite
+  
+  class Profile < Resource
+    
+    def self.resource
+      super 'profiles'
+    end
+    
+    def self.artist(id)
+      get resource["artist/#{id}.json"]
+    end
+    
+    def self.search(url)
+      get resource["search.json?u=#{CGI.escape(url)}"] do |response|
+        idfy response
+      end
+    end
+    
+    def self.add(artist_id, profiles)
+      params = {
+        :key => NextBigSoundLite.private_key,
+        :profiles => profiles
+      }
+      post resource["add/#{artist_id}.json"], params
+    end
+    
+  end
+  
+end

data/lib/next_big_sound_lite/resources/service.rb

@@ -0,0 +1,19 @@
+require 'cgi'
+
+module NextBigSoundLite
+  
+  class Service < Resource
+    
+    def self.resource
+      super 'services.json'
+    end
+        
+    def self.list
+      get resource do |response|
+        idfy response
+      end
+    end
+    
+  end
+
+end

data/lib/next_big_sound_lite/version.rb

@@ -0,0 +1,3 @@
+module NextBigSoundLite
+  VERSION = "1.0.0"
+end

data/next_big_sound_lite.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "next_big_sound_lite/version"
+
+Gem::Specification.new do |s|
+  s.name        = "next-big-sound-lite"
+  s.version     = NextBigSoundLite::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Roberto Thais"]
+  s.email       = ["roberto.thais@gigmaven.com"]
+  s.homepage    = ""
+  s.summary     = %q{A small wrapper around the Next Big Sound API}
+  s.description = %q{A small wrapper around the Next Big Sound API}
+
+  s.rubyforge_project = "next-big-sound-lite"
+  
+  s.add_dependency "rest-client"
+  s.add_dependency "hashie"
+  s.add_dependency "json"
+
+  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

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: next-big-sound-lite
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors: 
 - Roberto Thais
@@ -14,100 +10,93 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 -04:00
+date: 2011-04-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: hashie
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
-description: Thin wrapper for the Next Big Sound API.
-email: roberto.n.thais@gmail.com
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A small wrapper around the Next Big Sound API
+email: 
+- roberto.thais@gigmaven.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
-- lib/next-big-sound-lite.rb
-- lib/next-big-sound-lite/artist.rb
-- lib/next-big-sound-lite/genre.rb
-- lib/next-big-sound-lite/metric.rb
-- lib/next-big-sound-lite/profile.rb
-- lib/next-big-sound-lite/resource.rb
-- lib/next-big-sound-lite/service.rb
-- lib/next-big-sound-lite/track.rb
-- lib/next-big-sound-lite/youtube.rb
+extra_rdoc_files: []
+
 files: 
-- Manifest
-- README.rdoc
+- .gitignore
+- Gemfile
+- README.md
 - Rakefile
-- init.rb
 - lib/next-big-sound-lite.rb
-- lib/next-big-sound-lite/artist.rb
-- lib/next-big-sound-lite/genre.rb
-- lib/next-big-sound-lite/metric.rb
-- lib/next-big-sound-lite/profile.rb
-- lib/next-big-sound-lite/resource.rb
-- lib/next-big-sound-lite/service.rb
-- lib/next-big-sound-lite/track.rb
-- lib/next-big-sound-lite/youtube.rb
-- next-big-sound-lite.gemspec
+- lib/next_big_sound_lite.rb
+- lib/next_big_sound_lite/resource.rb
+- lib/next_big_sound_lite/resources/artist.rb
+- lib/next_big_sound_lite/resources/genre.rb
+- lib/next_big_sound_lite/resources/metric.rb
+- lib/next_big_sound_lite/resources/profile.rb
+- lib/next_big_sound_lite/resources/service.rb
+- lib/next_big_sound_lite/version.rb
+- next_big_sound_lite.gemspec
 has_rdoc: true
-homepage: http://github.com/rpbertp13/next-big-sound-lite
+homepage: ""
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Next-big-sound-lite
-- --main
-- README.rdoc
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+      version: "0"
 requirements: []
 
 rubyforge_project: next-big-sound-lite
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Thin wrapper for the Next Big Sound API.
+summary: A small wrapper around the Next Big Sound API
 test_files: []
 

data/Manifest

@@ -1,13 +0,0 @@
-Manifest
-README.rdoc
-Rakefile
-init.rb
-lib/next-big-sound-lite.rb
-lib/next-big-sound-lite/artist.rb
-lib/next-big-sound-lite/genre.rb
-lib/next-big-sound-lite/metric.rb
-lib/next-big-sound-lite/profile.rb
-lib/next-big-sound-lite/resource.rb
-lib/next-big-sound-lite/service.rb
-lib/next-big-sound-lite/track.rb
-lib/next-big-sound-lite/youtube.rb

data/README.rdoc

@@ -1,27 +0,0 @@
-== Next Big Sound Lite
-
-This gem wraps the next big sound JSON api. Read the API docs {here}[http://api.nextbigsound.com].
-
-Done? Then you can use this API.
-
-First setup the gem to use your API key:
-
-  NBS.api_key = 'your_key'
-
-The methods of this wrapper are organized in the same way as the subsections of the API docs. For example to call the endpoint 'view' on Artists you should call:
-
-  NBS::Artist.view(id)
-
-Notice that the receiver has a singular name (ala Rails Models)
-
-Another example:
-
-  NBS::Metric.profile(id)
-
-Would call the Profile endpoint defined under the Metrics subsection. And so on.
-
-The one gotcha is the rank endpoint on the Artists subsection. It expects a type and an array of ids. E.g.
-
-  NBS::Artist.rank(type, [365, 654, 123])
-
-All methods return parsed an array or a hash. No effort is made at this point to create objects out of the raw data. This is where 'lite' comes from :)

data/init.rb

@@ -1,2 +0,0 @@
-# init.rb
-require 'next-big-sound-lite'

data/lib/next-big-sound-lite/artist.rb

@@ -1,31 +0,0 @@
-module NBS
-  
-  class Artist < Resource
-    
-    def self.resource
-      super 'artists'
-    end
-    
-    def self.view(id)
-      res = resource["view/#{id}.json"].get
-      JSON.parse(res)
-    end
-    
-    def self.search(q)
-      res = resource["search.json?q=#{CGI.escape(q)}"].get
-      JSON.parse(res)
-    end
-    
-    def self.ranking(type, ids)
-      ids = ids.join('-')
-      res = resource["rank/#{type}/#{ids}.json"].get
-      JSON.parse(res)
-    end  
-    
-    def self.add(name)
-      res = resource["add.json?n=#{CGI.escape(name)}&k=#{NBS.private_key}"].get
-      JSON.parse(res)
-    end
-  end
-  
-end

data/lib/next-big-sound-lite/metric.rb

@@ -1,20 +0,0 @@
-module NBS
-  
-  class Metric < Resource
-    
-    def self.resource
-      super 'metrics'
-    end
-    
-    def self.profile(id)
-      res = resource["profile/#{id}.json"].get
-      JSON.parse(res)
-    end
-    
-    def self.artist(id)
-      res = resource["artist/#{id}.json"].get
-      JSON.parse(res)
-    end
-  end
-
-end

data/lib/next-big-sound-lite/profile.rb

@@ -1,26 +0,0 @@
-module NBS
-  
-  class Profile < Resource
-    
-    def self.resource
-      super 'profiles'
-    end
-    
-    def self.artist(id)
-      res = resource["artist/#{id}.json"].get
-      JSON.parse(res)
-    end
-    
-    def self.search(url)
-      res = resource["search.json?u=#{CGI.escape(url)}"].get
-      JSON.parse(res)
-    end
-    
-    def self.add(artist_id, url)
-      res = resource["add/#{artist_id}.json?u=#{CGI::escape(url)}&k=#{NBS.private_key}"].get
-      JSON.parse(res)
-    end
-    
-  end
-  
-end

data/lib/next-big-sound-lite/resource.rb

@@ -1,10 +0,0 @@
-module  NBS
-  
-  class Resource
-    def self.resource(name)
-      NBS.base[name]
-    end
-  end
-  
-end
-  

data/lib/next-big-sound-lite/service.rb

@@ -1,15 +0,0 @@
-module NBS
-  
-  class Service < Resource
-    
-    def self.resource
-      super 'services'
-    end
-        
-    def self.list
-      JSON.parse(resource['.json'].get)
-    end
-    
-  end
-
-end

data/lib/next-big-sound-lite/track.rb

@@ -1,20 +0,0 @@
-module NBS
-  
-  class Track < Resource
-    
-    def self.resource
-      super 'tracks'
-    end
-    
-    def self.artist(id)
-      res = resource["artist/#{id}.json"].get
-      JSON.parse(res)
-    end
-    
-    def self.profile(id)
-      res = resource["profile/#{id}.json"].get
-      JSON.parse(res)
-    end
-  end
-
-end

data/lib/next-big-sound-lite/youtube.rb

@@ -1,16 +0,0 @@
-module NBS
-  
-  class Youtube < Resource
-    
-    def self.resource
-      super 'youtube'
-    end
-    
-    def self.artist(id)
-      res = resource["artist/#{id}.json"].get
-      JSON.parse(res)
-    end
-    
-  end
-
-end

data/next-big-sound-lite.gemspec

@@ -1,36 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{next-big-sound-lite}
-  s.version = "0.2.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Roberto Thais"]
-  s.date = %q{2010-06-11}
-  s.description = %q{Thin wrapper for the Next Big Sound API.}
-  s.email = %q{roberto.n.thais@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/next-big-sound-lite.rb", "lib/next-big-sound-lite/artist.rb", "lib/next-big-sound-lite/genre.rb", "lib/next-big-sound-lite/metric.rb", "lib/next-big-sound-lite/profile.rb", "lib/next-big-sound-lite/resource.rb", "lib/next-big-sound-lite/service.rb", "lib/next-big-sound-lite/track.rb", "lib/next-big-sound-lite/youtube.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/next-big-sound-lite.rb", "lib/next-big-sound-lite/artist.rb", "lib/next-big-sound-lite/genre.rb", "lib/next-big-sound-lite/metric.rb", "lib/next-big-sound-lite/profile.rb", "lib/next-big-sound-lite/resource.rb", "lib/next-big-sound-lite/service.rb", "lib/next-big-sound-lite/track.rb", "lib/next-big-sound-lite/youtube.rb", "next-big-sound-lite.gemspec"]
-  s.homepage = %q{http://github.com/rpbertp13/next-big-sound-lite}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Next-big-sound-lite", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{next-big-sound-lite}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Thin wrapper for the Next Big Sound API.}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rest-client>, [">= 0"])
-      s.add_development_dependency(%q<json>, [">= 0"])
-    else
-      s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-  end
-end