firstfm 0.4.1 → 0.5.0

data/README.rdoc

@@ -8,9 +8,17 @@ My main focus is to import events from Last.FM, but with time I will try to add
 
   sudo gem install firstfm
 
-  create a ~/.firstfm file with this content
+or add to your Gemfile
   
-  api_key: YOUR_API_KEY
+  gem 'firstfm'
+
+== Configuration
+
+This goes to your initializers/firstfm.rb
+
+  Firstfm.configure do |ffm|
+    ffm.api_key = "YOUR_KEY_HERE"
+  end
 
 == Usage
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 :major: 0
-:minor: 4
-:patch: 1
+:minor: 5
+:patch: 0
 :build: 

data/firstfm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "firstfm"
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aleksandr Lossenko"]
-  s.date = "2012-07-18"
+  s.date = "2013-01-02"
   s.description = "Firstfm is a ruby wrapper for the Last.fm APIs ( http://www.last.fm/api ). My main focus is to import events from Last.FM, but with time I will try to add support for all API methods."
   s.email = "aleksandr.lossenko@gmail.com"
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "firstfm.gemspec",
     "lib/firstfm.rb",
     "lib/firstfm/artist.rb",
+    "lib/firstfm/configuration.rb",
     "lib/firstfm/event.rb",
     "lib/firstfm/geo.rb",
     "lib/firstfm/image.rb",

data/lib/firstfm/artist.rb

@@ -20,7 +20,7 @@ module Firstfm
 
     def get_tags
       name_params = self.mbid.nil? ? {:artist => self.name} : {:mbid => self.mbid}
-      response = self.class.get("/2.0/", {:query => {:method => 'artist.getInfo', :api_key => Firstfm::CONFIG['api_key']}.merge(name_params)})
+      response = self.class.get("/2.0/", {:query => {:method => 'artist.getInfo', :api_key => Firstfm.config.api_key}.merge(name_params)})
       tags_array = (response["lfm"] and response["lfm"]["artist"] and response["lfm"]["artist"]["tags"] and response["lfm"]["artist"]["tags"]["tag"]) || []
       tags_array.map {|t| t["name"] }
     end
@@ -31,7 +31,7 @@ module Firstfm
     
     def get_images(page = 1, limit = 50)
       name_params = self.mbid.nil? ? {:artist => self.name} : {:mbid => self.mbid}
-      response = self.class.get("/2.0/", {:query => {:method => 'artist.getImages', :page => page, :limit => limit, :api_key => Firstfm::CONFIG['api_key']}.merge(name_params)})
+      response = self.class.get("/2.0/", {:query => {:method => 'artist.getImages', :page => page, :limit => limit, :api_key => Firstfm.config.api_key}.merge(name_params)})
       images_array = (response["lfm"] and response["lfm"]["images"] and response["lfm"]["images"]["image"]) || []
       images = Image.init_from_array(images_array)
       WillPaginate::Collection.create(page, limit) do |pager|
@@ -41,7 +41,7 @@ module Firstfm
     end
     
     def self.search(artist, page = 1, limit = 50)
-      response = get("/2.0/", {:query => {:method => 'artist.search', :artist => artist, :page => page, :limit => limit, :api_key => Firstfm::CONFIG['api_key']}})
+      response = get("/2.0/", {:query => {:method => 'artist.search', :artist => artist, :page => page, :limit => limit, :api_key => Firstfm.config.api_key}})
       artists_array = (response and response["lfm"] and response["lfm"]["results"] and response["lfm"]["results"]["artistmatches"] and response["lfm"]["results"]["artistmatches"]["artist"]) || []
       artists = Artist.init_from_array(artists_array)
       WillPaginate::Collection.create(page, limit) do |pager|
@@ -51,7 +51,7 @@ module Firstfm
     end
     
     def self.get_top_tracks(artist, page = 1, limit = 50)
-      response = get("/2.0/", {:query => {:method => 'artist.getTopTracks', :artist => artist, :page => page, :limit => limit, :api_key => Firstfm::CONFIG['api_key']}})
+      response = get("/2.0/", {:query => {:method => 'artist.getTopTracks', :artist => artist, :page => page, :limit => limit, :api_key => Firstfm.config.api_key}})
       tracks_array = (response and response["lfm"] and response["lfm"]["toptracks"] and response["lfm"]["toptracks"]["track"]) || []
       tracks = Track.init_from_array(tracks_array)
       WillPaginate::Collection.create(page, limit) do |pager|

data/lib/firstfm/configuration.rb

@@ -0,0 +1,24 @@
+module Firstfm
+  class Configuration
+    attr_accessor :api_key
+
+    DEFAULT_API_KEY = "REPLACE_WITH_REAL_KEY"
+
+    def initialize
+      @api_key = DEFAULT_API_KEY
+    end
+
+  end
+
+  module Configurable
+    def configure
+      raise "Configuration missing" unless block_given?
+      yield @config ||= Firstfm::Configuration.new
+    end
+
+    def config
+      @config
+    end
+  end
+  extend Configurable
+end

data/lib/firstfm/geo.rb

@@ -13,7 +13,7 @@ module Firstfm
       page = params.delete(:page) || 1
       distance = params.delete(:distance)
       
-      response = get("/2.0/", {:query => {:method => 'geo.getevents', :location => location, :page => page, :lat => lat, :lng => lng, :distance => distance, :api_key => Firstfm::CONFIG['api_key']}})
+      response = get("/2.0/", {:query => {:method => 'geo.getevents', :location => location, :page => page, :lat => lat, :lng => lng, :distance => distance, :api_key => Firstfm.config.api_key}})
       events = response && response['lfm'] ? Event.init_events_from_hash(response['lfm']) : []
       
       collection = WillPaginate::Collection.create(page, 10) do |pager|
@@ -33,7 +33,7 @@ module Firstfm
         :country => country,
         :page => page, 
         :limit => limit, 
-        :api_key => Firstfm::CONFIG['api_key']
+        :api_key => Firstfm.config.api_key
       }})
       
       artists_array = (response and response['lfm'] and response['lfm']['topartists'] and response['lfm']['topartists']['artist']) || []
@@ -72,7 +72,7 @@ module Firstfm
         :end => end_timestamp,
         :page => page, 
         :limit => limit, 
-        :api_key => Firstfm::CONFIG['api_key'] }.reject {|k,v| v.nil?}
+        :api_key => Firstfm.config.api_key }.reject {|k,v| v.nil?}
       })
       
       artists_array = (response and response['lfm'] and response['lfm']['topartists'] and response['lfm']['topartists']['artist']) || []

data/lib/firstfm/track.rb

@@ -9,7 +9,7 @@ module Firstfm
     format :xml
     
     def self.search(track, page = 1, limit = 30)
-      response = get("/2.0/", {:query => {:method => 'track.search', :track => track, :page => page, :limit => limit, :api_key => Firstfm::CONFIG['api_key']}})
+      response = get("/2.0/", {:query => {:method => 'track.search', :track => track, :page => page, :limit => limit, :api_key => Firstfm.config.api_key}})
       tracks_array = (response and response["lfm"] and response["lfm"]["results"] and response["lfm"]["results"]["trackmatches"] and response["lfm"]["results"]["trackmatches"]["track"]) || []
       tracks = Track.init_from_array(tracks_array)
       WillPaginate::Collection.create(page, limit) do |pager|

data/lib/firstfm/venue.rb

@@ -9,7 +9,7 @@ module Firstfm
     format :xml
     
     def self.search(venue, page = 1, limit = 50, country = nil)
-      response = get("/2.0/", {:query => {:method => 'venue.search', :venue => venue, :page => page, :limit => limit, :country => country, :api_key => Firstfm::CONFIG['api_key']}})
+      response = get("/2.0/", {:query => {:method => 'venue.search', :venue => venue, :page => page, :limit => limit, :country => country, :api_key => Firstfm.config.api_key}})
       venues = response && response['lfm'] ? Venue.init_venues_from_hash(response['lfm']) : []
       collection = WillPaginate::Collection.create(page, limit) do |pager|
         pager.replace venues
@@ -18,7 +18,7 @@ module Firstfm
     end
     
     def self.get_events(venue_id)
-      response = get("/2.0/", {:query => {:method => 'venue.getEvents', :venue => venue_id, :api_key => Firstfm::CONFIG['api_key']}})
+      response = get("/2.0/", {:query => {:method => 'venue.getEvents', :venue => venue_id, :api_key => Firstfm.config.api_key}})
       events = response && response['lfm'] ? Event.init_events_from_hash(response['lfm']) : []
     end
     

data/lib/firstfm.rb

@@ -3,6 +3,7 @@ require 'crack'
 require 'httparty'
 require 'chronic'
 require 'will_paginate/collection'
+require 'firstfm/configuration'
 require 'firstfm/track'
 require 'firstfm/image'
 require 'firstfm/artist'
@@ -13,6 +14,6 @@ require 'firstfm/geo'
 
 module Firstfm
   
-  CONFIG = YAML::load(File.read(File.join(ENV['HOME'], '.firstfm')))
+  GH_PAGE_URL = "https://github.com/egze/firstfm"
   
 end

data/test/helper.rb

@@ -14,5 +14,10 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'firstfm'
 
+Firstfm.configure do |ffm|
+  ffm.api_key = "TEST"
+end
+
 class Test::Unit::TestCase
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firstfm
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -159,6 +159,7 @@ files:
 - firstfm.gemspec
 - lib/firstfm.rb
 - lib/firstfm/artist.rb
+- lib/firstfm/configuration.rb
 - lib/firstfm/event.rb
 - lib/firstfm/geo.rb
 - lib/firstfm/image.rb
@@ -197,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1482993190146460741
+      hash: 2311566496128087561
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: