next-big-sound 0.1.2 → 0.2.0

data/README.rdoc

@@ -28,28 +28,36 @@ This code was written by jeff at musicxray.com if you think you can do better se
 	# get the first artist that you find and find
 	# all associated profiles.   myspace, ilike ....
 	
-	profiles = searchobj.artists.first.profiles 
-		
+	artist = searchobj.artists.first
+	
+	artist.profiles 
 	# get the url for a specific service
 		
-	profiles["MYSPACE"]
-		
+	artist.profiles["MYSPACE"]	
 	# in addition.  There is are magic method for retrieving data
 	# if you want myspace plays for example you would get it like this
 	
-	artist = 	searchobj.artists.first
-
-  # this will fetch you a month worth of myspace plays data	
-	artist.myspace_plays("1/1/2010","2/1/2010")
+	# Each profile can have multiple metrics 
+	# each metric has an array of datapoints.  
+	# datapoints consist of a DateTime Object and a float
+	# example usage follows
+	
+	profile = artist.profiles["MYSPACE"]
+	
+	metrics = profile.metrics("4/24/2009","4/24/2010")
+	datapoints = metrics["plays"].data_points
 	
-	# this will find all fans for a particular artist across all
-	# services.
-	artist.all_fans("1/1/2010","2/1/2010")
+	#The datapoints array can then be iterated over.
 	
-	# The data points are returned as an array of datasets
-	# One dataset per profile Datasets can be sorted by date 
+	#shortcut methods have been provided for convenience is as follows
+	
+	artist.myspace_plays_datapoints("4/24/2009","4/24/2010")
+	
+	This will return the datapoints you are looking for .... 
+	
+
+
 	
-	#  TODO: this stuff is still be implemented.
 
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/artist.rb

@@ -3,13 +3,15 @@ module NBS
   
     attr_accessor :artist_id, :name, :xml, :options
       
+    PROFILES = %w(all myspace lastfm ilike facebook twitter youtube reverbnation ourstage soundcloud purevolume bebo virb amiestreet jamlegend vimeo)
+      
     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
+    def fetch_profiles
       self.xml=Net::HTTP.get(URI.parse("#{NBS::NBS_CONFIG["base_url"]}getProfilesForArtist?#{self.options.to_url_params}")).to_s
     end
     
@@ -18,27 +20,22 @@ module NBS
       ####
       profs = {}
       self.to_hash["Profiles"][0]["Profile"].each do |item|
-        profs[item["service"]]=item["url"]
+        profs[item["service"].to_s]=ArtistProfile.new(self.artist_id, item["service"] ,item["url"])
       end
       return profs
     end
-    
     def to_xml
-      self.xml ||= fetch_profile
+      self.xml ||= fetch_profiles
     end
     def to_hash
       Hash.from_xml(self.to_xml)
     end
     
     def method_missing(method_name,*args)
-      if splits = method_name.to_s.split("_")
-        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})
-        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
+      splits = method_name.to_s.split("_")
+      prof = self.profiles[splits[0].upcase]
+      metrics = prof.metrics(args[0],args[1])
+      return metrics[splits[1].downcase.to_s].data_points
     end
     
   end

data/lib/artist_profile.rb

@@ -0,0 +1,26 @@
+module NBS
+
+  class ArtistProfile
+     METRICS = %w(plays fans views comments downloads likes price)
+
+      attr_accessor :service_type,:url, :artist_id, :options
+
+      def initialize(artist_id,service_type, url="" ,options={})
+        self.service_type = service_type 
+        self.artist_id = artist_id 
+        self.url = url
+      end
+
+      def metrics(sdate,edate)
+        @metrics ||= load_metrics(sdate,edate)
+      end
+
+      def load_metrics(sdate,edate)
+        metrics ={}
+        METRICS.each do |metric_string|
+          metrics[metric_string.to_s] = Metric.new(self.artist_id,self.service_type,metric_string.to_s,sdate,edate)
+        end
+        return metrics
+      end
+  end
+end

data/lib/datapoint.rb

@@ -0,0 +1,12 @@
+module NBS
+  class DataPoint
+  
+    attr_accessor :time, :value
+    
+    def initialize(time,value)
+      self.time = DateTime.parse(time.to_s)
+      self.value = value.to_f
+    end
+    
+  end
+end

data/lib/metric.rb

@@ -0,0 +1,37 @@
+module NBS
+  
+  class Metric
+
+    attr_accessor :artist_id,:service_type,:metric,:sdate,:edate, :xml
+    def initialize(artist_id,service_type,metric,sdate,edate)
+      self.artist_id = artist_id
+      self.service_type = service_type
+      self.metric = metric
+      self.sdate = Date.parse(sdate.to_s)
+      self.edate = Date.parse(edate.to_s)  
+    end
+    def fetch
+      options = {"service"=>self.service_type,"metric"=>self.metric,"start"=>self.sdate.to_s,"end"=>self.edate.to_s,"artistID"=>self.artist_id,"apiKey"=>$nbs_api_key,"format"=>"xml"}
+      puts "#{NBS::NBS_CONFIG["base_url"]}getDataForArtist?#{options.to_url_params}"
+      statsxml = Net::HTTP.get(URI.parse("#{NBS::NBS_CONFIG["base_url"]}getDataForArtist?#{options.to_url_params}")).to_s
+    end
+    def data_points
+      begin
+        points = to_hash["Profiles"][0]["Profile"][0]["DataPoint"]
+        dps = []
+        points.each do |dp|
+          dps << DataPoint.new(dp["date"],dp["value"])
+        end
+        return dps
+      rescue
+        return []
+      end
+    end
+    def to_xml
+      self.xml ||= fetch
+    end
+    def to_hash
+      Hash.from_xml(to_xml)
+    end
+  end
+end

data/lib/next-big-sound.rb

@@ -5,6 +5,10 @@ module NBS
   require 'hash_extension'
   require 'search'
   require 'artist'
+  require 'artist_profile'
+  require 'metric'
+  require 'datapoint'
+  
 
   NBS_CONFIG = YAML.load_file("config.yml")
   

data/next-big-sound.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{next-big-sound}
-  s.version = "0.1.2"
+  s.version = "0.2.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-27}
+  s.date = %q{2010-03-29}
   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 = [
@@ -25,7 +25,10 @@ Gem::Specification.new do |s|
      "VERSION",
      "config.yml",
      "lib/artist.rb",
+     "lib/artist_profile.rb",
+     "lib/datapoint.rb",
      "lib/hash_extension.rb",
+     "lib/metric.rb",
      "lib/next-big-sound.rb",
      "lib/search.rb",
      "next-big-sound.gemspec",

data/test/helper.rb

@@ -4,7 +4,7 @@ require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'base'
+require 'next-big-sound'
 
 class Test::Unit::TestCase
 end

data/test/test_search.rb

@@ -22,8 +22,8 @@ class TestNextBigSound < Test::Unit::TestCase
   	  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)
+	    should "metrics for profile" do
+	      assert @searchobj.artists.first.profiles.first.is_a?(Profile)
       end
 	  end
     #should "have many re"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - jeff durand
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-27 00:00:00 -04:00
+date: 2010-03-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,10 @@ files:
 - VERSION
 - config.yml
 - lib/artist.rb
+- lib/artist_profile.rb
+- lib/datapoint.rb
 - lib/hash_extension.rb
+- lib/metric.rb
 - lib/next-big-sound.rb
 - lib/search.rb
 - next-big-sound.gemspec