next-big-sound 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/credentials.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jeff durand
+
+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.rdoc

@@ -0,0 +1,17 @@
+= next-big-sound
+
+This is the start of a ruby api wrapper for nextbigsound.com.  This gem will provide a reasonable ruby wrapper for all methods in the public API.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 jeff durand. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "next-big-sound"
+    gem.summary = %Q{Next Big Sound}
+    gem.description = %Q{A simple wrapper class for the Next Big Sound api.  docs for the api can be found at api.nextbigsound.com}
+    gem.email = "jeff.durand@gmail.com"
+    gem.homepage = "http://github.com/johnnyiller/next-big-sound"
+    gem.authors = ["jeff durand"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "next-big-sound #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config.yml

@@ -0,0 +1 @@
+base_url: "http://api.nextbigsound.com/v1_1/"

data/lib/artist.rb

@@ -0,0 +1,48 @@
+module NBS
+  class Artist
+  
+    attr_accessor :artist_id, :name, :xml, :options
+      
+    def initialize(artist_id, name="",options={})
+      self.artist_id=artist_id
+      self.name = name
+      self.options = {"artistID"=>self.artist_id,"apiKey"=>$nbs_api_key,"format"=>"xml"}.merge(options)
+    end
+    
+    def fetch_profile
+      self.xml=Net::HTTP.get(URI.parse("#{NBS::NBS_CONFIG["base_url"]}getProfilesForArtist?#{self.options.to_url_params}")).to_s
+    end
+    
+    # return a hash of urls keyed by the service.
+    def profiles
+      ####
+      profs = {}
+      self.to_hash["Profiles"][0]["Profile"].each do |item|
+        profs[item["service"]]=item["url"]
+      end
+      return profs
+    end
+    
+    def to_xml
+      self.xml ||= fetch_profile
+    end
+    def to_hash
+      Hash.from_xml(self.to_xml)
+    end
+    
+    def method_missing(method_name,*args)
+      if splits = method_name.to_s.split("_")
+        puts args.inspect
+        sdate = Date.parse(args[0].to_s)
+        edate = Date.parse(args[1].to_s)
+        opts = options.merge({"service"=>splits[0],"metric"=>splits[1],"start"=>sdate.to_s,"end"=>edate.to_s})
+        puts opts.inspect
+        puts "http://api.nextbigsound.com/v1_1/getDataForArtist?#{opts.to_url_params}"
+        return Net::HTTP.get(URI.parse("#{NBS::NBS_CONFIG["base_url"]}getDataForArtist?#{opts.to_url_params}")).to_s
+      else
+        raise "Sorry that method does not exist. The proper format for finding data is service_metric(start,end)"
+      end
+    end
+    
+  end
+end

data/lib/base.rb

@@ -0,0 +1,25 @@
+module NBS
+  
+  $LOAD_PATH << './lib'
+  require 'yaml'
+  require 'hash_extension'
+  require 'search'
+  require 'artist'
+
+  NBS_CONFIG = YAML.load_file("config.yml")
+  
+  class Base
+     
+    def initialize(api_key)
+      $nbs_api_key = api_key
+    end
+    # return a search object that you can manipulate
+    # if you prefer to just use the xml simply type to_xml
+    # this method with actually fetch the result
+    def search(query, options={} )
+      search = Search.new(query,options)
+      search.fetch
+      return search
+    end
+  end
+end

data/lib/hash_extension.rb

@@ -0,0 +1,17 @@
+require "cgi"
+require 'rubygems'
+require 'xmlsimple'
+
+class Hash
+  def to_url_params
+    elements = []
+    keys.size.times do |i|
+      elements << "#{CGI::escape(keys[i])}=#{CGI::escape(values[i])}"
+    end
+    elements.join('&')
+  end
+  
+  def self.from_xml(xml_data)
+    XmlSimple.xml_in(xml_data)
+  end 
+end

data/lib/search.rb

@@ -0,0 +1,34 @@
+module NBS
+  
+  require 'net/http'
+  require 'uri'
+  
+  class Search
+  
+    attr_accessor :options, :query, :api_key,:base_url, :xml
+      
+    def initialize(query, options={})
+      self.options = {"query"=>query,"apiKey"=>$nbs_api_key,"format"=>"xml"}.merge(options)
+      self.query = query
+      self.api_key = api_key
+      self.base_url = base_url
+    end
+  
+    def fetch
+      self.xml=Net::HTTP.get(URI.parse("#{NBS::NBS_CONFIG["base_url"]}search?#{self.options.to_url_params}")).to_s
+    end
+    
+    def artists
+      hash = Hash.from_xml(self.xml)
+      a = []
+      hash["Results"][0]["Result"].each do |item|
+       a << Artist.new(item["NBSArtistID"][0],item["NBSArtistName"][0])
+      end
+      return a
+    end
+    
+    def to_xml
+      self.xml
+    end
+  end
+end

data/next-big-sound.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{next-big-sound}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jeff durand"]
+  s.date = %q{2010-03-26}
+  s.description = %q{A simple wrapper class for the Next Big Sound api.  docs for the api can be found at api.nextbigsound.com}
+  s.email = %q{jeff.durand@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "config.yml",
+     "lib/artist.rb",
+     "lib/base.rb",
+     "lib/hash_extension.rb",
+     "lib/search.rb",
+     "next-big-sound.gemspec",
+     "test/helper.rb",
+     "test/test_search.rb"
+  ]
+  s.homepage = %q{http://github.com/johnnyiller/next-big-sound}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Next Big Sound}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_search.rb"
+  ]
+
+  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<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'base'
+
+class Test::Unit::TestCase
+end

data/test/test_search.rb

@@ -0,0 +1,31 @@
+require 'helper'
+require 'yaml'
+
+class TestNextBigSound < Test::Unit::TestCase
+  include NBS
+  context "Has Valid api key" do 
+    setup do 
+      # get the api key from the yaml file
+      YAML.load_file("./test/credentials.yml").each { |key,value| instance_variable_set("@#{key}", value) }
+      @nbs = Base.new(@api_key)
+    end
+  	context "Assuming we are able to search for the killers" do 
+	    setup do 
+         @searchobj = @nbs.search("The Killers")
+      end
+	    should "Be able to find The Killers ArtistID" do
+        assert_match /<NBSArtistID>\d+<\/NBSArtistID>/i, @searchobj.to_xml
+    	end
+    	should "have an array of results" do 
+  	    assert !@searchobj.artists.empty?
+  	  end
+  	  should "have first result with artist name of The Killers" do 
+	      assert_equal "The Killers", @searchobj.artists.first.name
+	    end
+	    should "be able to get some data" do
+	      assert @searchobj.artists.first.myspace_plays("4/24/2009","4/24/2010").is_a?(Array)
+      end
+	  end
+    #should "have many re"
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: next-big-sound
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- jeff durand
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A simple wrapper class for the Next Big Sound api.  docs for the api can be found at api.nextbigsound.com
+email: jeff.durand@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- config.yml
+- lib/artist.rb
+- lib/base.rb
+- lib/hash_extension.rb
+- lib/search.rb
+- next-big-sound.gemspec
+- test/helper.rb
+- test/test_search.rb
+has_rdoc: true
+homepage: http://github.com/johnnyiller/next-big-sound
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Next Big Sound
+test_files: 
+- test/helper.rb
+- test/test_search.rb