spof 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2adcff75e550b47903d2324b70354dbf990dc5e
-  data.tar.gz: fa9fd3eade9b2cbf32308e3e0f4382165af83e69
+  metadata.gz: 14e4d99c31f28c5dfa38a952cb824c919d57d060
+  data.tar.gz: 4a912d496c0ce57d59a8f7969f33165d4c3d80af
 SHA512:
-  metadata.gz: c18068a2f46c94857659f3da03f78efae0486d95f5d5e30d86bf3e518d5a0f614ba12a043c9093ce5ff0cad9cbad4c585d182627b5cf20c27b402b063a3239c1
-  data.tar.gz: 14ead18152717a1c53383212467b0844e9965a31070e9c336f54478fe6702e72380f363f5d726a6f0887ae8845a72fad8ea1a39ac69b5316254d3b9aab8c61b0
+  metadata.gz: 08dc22de887e35eaaae93875009580a69fa7d2755528ca8372694e8c9b10f50d1227eb171eff94f9dfc3f055f79ef5829b426354da95ec5642592ea602eda160
+  data.tar.gz: daaf8cc22d21929419fb278842150bdcf503be0a754193e53f1c10777210d0ba231e833a2e02a6458a32c842c60b27cd67c0aea0fd4a9710b021afeac5b666a6

data/README.md

@@ -7,6 +7,44 @@ Ruby wrapper for the Spotify Search & Lookup API. Under development.
 
 [![Gem Version](https://badge.fury.io/rb/spof.png)](http://badge.fury.io/rb/spof)
 
+
+Usage
+-----
+
+```ruby
+require 'spof'
+```
+
+### Search
+
+
+```ruby
+r = Spof::Search.artist('nine inch nails') # or album or track
+
+# a page can be specified
+r = Spof::Search.track('life on mars', page = 2)
+```
+
+### Lookup
+
+```ruby
+r = Spof::Lookup.get('spotify:uri:album:xy...z')
+
+# extras can be specified
+r = Spof::Lookup.get('spotify:uri:album:xy...z', :track)
+
+# convenience methods Lookup.album/artist/track check the provided extras
+r = Spof::Lookup.artist('spotify:uri:artist:ab...c', :trackdetail)
+# raises Spof::SpofError, "Illegal extra"
+```
+
+
+For both `Lookup` and `Search` methods, the result contains the parsed JSON response. For now it's like:
+
+```ruby  
+r = JSON.parse(spotify_api_json_response, :symbolize_names => true) # hash with symbols as keys
+```
+
 License
 -------
 

data/lib/spof/version.rb

@@ -1,3 +1,3 @@
 module Spof
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spof.gemspec

@@ -1,23 +1,23 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'spof/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "spof"
-  spec.version       = Spof::VERSION
-  spec.authors       = ["ignaciocontreras"]
-  spec.email         = ["ignacio@ignacio.cat"]
-  spec.description   = %q{Spotify Search & Lookup API Ruby wrapper}
-  spec.summary       = %q{Spotify Search & Lookup}
-  spec.homepage      = "http://github.com/ignaciocontreras/spof"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spof"
+  spec.version       = Spof::VERSION
+  spec.authors       = ["Ignacio Contreras"]
+  spec.email         = ["ignacio@ignacio.cat"]
+  spec.description   = %q{Spotify Search & Lookup API Ruby wrapper}
+  spec.summary       = %q{Spotify Search & Lookup}
+  spec.homepage      = "http://github.com/ignaciocontreras/spof"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.2"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spof
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
-- ignaciocontreras
+- Ignacio Contreras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement