turntabler 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # master
 
+## 0.1.2 / 2012-12-01
+
+* Fix song searches being allowed when the user isn't in a room
+* Allow title / artist / duration to be explicitly specified in song searches
+
 ## 0.1.1 / 2012-11-27
 
 * Fix gemspec filename

data/README.md

@@ -36,9 +36,9 @@ This project was built from the ground-up by Rubyists for Rubyists.  While prior
 projects in other languages were used for guidance on some of the implementation,
 the design is meant to take advantage of the various features offered by Ruby 1.9+.
 
-Some brief, high-level features include:
+At a high level, this project features:
 
-* Evented, non-blocking IO
+* Evented, non-blocking I/O
 * Fiber-aware, untangled callbacks
 * Interactive console support
 * Clean, object-oriented APIs
@@ -177,25 +177,17 @@ directory in the repository.
 
 So you may be asking "Why another Turntable.FM API library?" or "Why re-build
 this in Ruby when you have a stable Javascript project?"  Simply put, I felt that
-all of the high-level features highlighted in the Description section of this
-document were missing in each of those existing libraries.
+many of the high-level details highlighted in the Description section of this
+document were missing in existing libraries.
 
-Existing implementations include:
+Some of those details include evented I/O, untangled callbacks, object-oriented
+APIs, external API consistency, internal state management, auto lazy-loading, etc.
+This library also strives to be a complete implementation, easy to use / play
+around with, and generally just put together a more organized fashion.
 
-* [turntable-api-rb](https://github.com/lmcalpin/turntable-api-rb)
-* [ruby_ttapi](https://github.com/alaingilbert/Turntable-API)
-* [TurntableBot](https://github.com/mrhazel/TurntableBot)
-
-My personal belief is that none of these libraries reflect the simplicity that
-you can build libraries with in Ruby.  Those include evented I/O, untangled
-callbacks, object-oriented APIs, external API consistency, internal state
-management, auto lazy-loading, etc.  Some of these libraries are also either
-incomplete implementations, difficult to use / play around with, or generally
-just put together as a script instead of an organized library.
-
-However, by no means does that mean I'm attempting to belittle the efforts put
-forth by these authors -- all of their work provided the foundation necessary to
-build out this project.
+By no means does this discredit the significance of the efforts put forth by the
+authors of these existing libraries -- all of their work provided the foundation
+necessary to build out this project.
 
 ### Authentication
 

data/examples/Gemfile.lock

@@ -17,7 +17,7 @@ GEM
     faye-websocket (0.4.6)
       eventmachine (>= 0.12.0)
     http_parser.rb (0.5.3)
-    turntabler (0.1.1)
+    turntabler (0.1.2)
       em-http-request
       em-synchrony
       faye-websocket

data/lib/turntabler/client.rb

@@ -401,18 +401,33 @@ module Turntabler
 
     # Finds songs that match the given query.
     # 
-    # @param [String] query The query string to search for
+    # @note The user must be entered in a room to search for songs
+    # @param [String] query The query string to search for.  This should just be the title of the song if :artist is specified.
     # @param [Hash] options The configuration options for the search
+    # @option options [String] :artist The name of the artist for the song
+    # @option options [Fixnum] :duration The length, in minutes, of the song
     # @option options [Fixnum] :page The page number to get from the results
     # @return [Array<Turntabler::Song>]
     # @raise [ArgumentError] if an invalid option is specified
-    # @raise [Turntabler::Error] if the command fails
+    # @raise [Turntabler::Error] if the user is not in a room or the command fails
     # @example
-    #   client.search_song('Like a Rolling Stone')  # => [#<Turntabler::Sticker ...>, ...]
+    #   # Less accurate, general query search
+    #   client.search_song('Like a Rolling Stone by Bob Dylan')             # => [#<Turntabler::Song ...>, ...]
+    #   
+    #   # More accurate, explicit title / artist search
+    #   client.search_song('Like a Rolling Stone', :artist => 'Bob Dylan')  # => [#<Turntabler::Song ...>, ...]
     def search_song(query, options = {})
-      assert_valid_keys(options, :page)
+      assert_valid_keys(options, :artist, :duration, :page)
       options = {:page => 1}.merge(options)
 
+      raise(Turntabler::Error, 'User must be in a room to search for songs') unless room
+
+      if artist = options[:artist]
+        query = "title: #{query}"
+        query << " artist: #{artist}"
+      end
+      query << " duration: #{options[:duration]}" if options[:duration]
+
       api('file.search', :query => query, :page => options[:page])
 
       # Wait for the async callback

data/lib/turntabler/version.rb

@@ -3,7 +3,7 @@ module Turntabler
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 1
+    PATCH = 2
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: turntabler
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: 
-  version: 0.1.1
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-28 00:00:00 Z
+date: 2012-12-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: em-synchrony
@@ -20,6 +25,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -31,6 +39,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -42,6 +53,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -53,6 +67,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id004
@@ -64,6 +81,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
         version: "2.11"
   type: :development
   version_requirements: *id005
@@ -75,6 +96,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id006
@@ -154,17 +178,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Turntable.FM API for Ruby