rapgenius 0.0.3 → 0.1.0

data/CHANGELOG.md

@@ -11,4 +11,8 @@ __v0.0.2__ (17th August 2013)
 __v0.0.3__ (22nd August 2013, *contributed by [tsigo](https://github.com/tsigo)*)
 
 * Improves implementation of HTTParty
-* Reorganises specs to use VCR
+* Reorganises specs to use VCR
+
+__v0.1.0__ (29th August 2013, *contributed by [tsigo](https://github.com/tsigo)*)
+
+* Adds support for searching for songs with `RapGenius::Song.search("Song, artist name or other query")`

data/README.md

@@ -15,7 +15,7 @@ with a nice bit of screen scraping with [Nokogiri](https://github.com/sparklemot
 Install the gem, and you're ready to go. Simply add the following to your
 Gemfile:
 
-`gem "rapgenius", "~> 0.0.2"`
+`gem "rapgenius", "~> 0.1.0"`
 
 ## Usage
 
@@ -77,14 +77,45 @@ annotation == annotations2
 # => true
 ```
 
+You can search for songs by artist and/or title.
+
+```ruby
+results = RapGenius::Song.search("Big Sean Control")
+# => [#<RapGenius::Song:0x007fbe4b9195e0
+#  @artist="Big Sean (Ft. Jay Electronica & Kendrick Lamar)",
+#  @title="Control",
+#  @url="http://rapgenius.com/Big-sean-control-lyrics">,
+# #<RapGenius::Song:0x007fbe4b920f70
+#  @artist="Big Sean (Ft. Jay Electronica & Kendrick Lamar)",
+#  @title="Control (French Version)",
+#  @url="http://rapgenius.com/Big-sean-control-french-version-lyrics">,
+# #<RapGenius::Song:0x007fbe4b920958
+#  @artist="Big Sean (Ft. Crobar, Jay Electronica & Kendrick Lamar)",
+#  @title="Control (Remix) [Kendrick Diss]",
+#  @url="http://rapgenius.com/Big-sean-control-remix-kendrick-diss-lyrics">,
+# #<RapGenius::Song:0x007fbe4b920250
+#  @artist=
+#   "Sa-roc (Ft. Big Sean - No I.D., Jay Electronica, Kendrick Lamar & Sa-roc)",
+#  @title="CONTROL",
+#  @url="http://rapgenius.com/Sa-roc-control-lyrics">,
+# #<RapGenius::Song:0x007fbe4b91ff30
+#  @artist="C3",
+#  @title=
+#   "Control ( Disses Kendrick Lamar , Jay-Z, Tyler The Creator, Big Sean, Meek Mill & More )",
+#  @url=
+#   "http://rapgenius.com/C3-control-disses-kendrick-lamar-jay-z-tyler-the-creator-big-sean-meek-mill-and-more-lyrics">]
+
+results[0].description
+# => "The non-album cut from Sean that basically blew up the Internet due to a world-beating verse by Kendrick Lamar...
+```
+
 ## Contributing
 
-There are a few things I'd love to see added to this gem:
+After the last few contributions, there's one core thing I'd like to add to the gem:
 
-* __Searching__ - having to know the path to a particular track's lyrics isn't super intuitive
-* __Support for *\*Genius*__ - RapG enius also have other sites on subdomains like [News Genius](http://news.rapgenius.com) and [Poetry Genius](http://poetry.rapgenius.com). These could very easily be supported, since theyre identical in terms of markup.
+* __Support for *\*Genius*__ - Rap Genius also have other sites on subdomains like [News Genius](http://news.rapgenius.com) and [Poetry Genius](http://poetry.rapgenius.com). These could very easily be supported, since theyre identical in terms of markup.
 
-This gem is open source, so feel free to add anything you want, then make a pull request. A few quick tips:
+If you'd like to contribute anything else, go ahead or better still, make an issue and we can talk it over and spec it out! A few quick tips:
 
 * Don't update the version numbers before your pull request - I'll sort that part out for you!
 * Make sure you write specs, then run them with `$ bundle exec rake`
@@ -92,4 +123,6 @@ This gem is open source, so feel free to add anything you want, then make a pull
 
 ## Get in touch
 
-Any questions, thoughts or comments? Email me at <me@timrogers.co.uk>.
+[timrogers](https://github.com/timrogers) and [tsigo](https://github.com/tsigo) are the gem's primary contributors.
+
+Any questions, thoughts or comments? Email me at <me+rapgenius@timrogers.co.uk> or create an issue.

data/lib/rapgenius/scraper.rb

@@ -24,6 +24,31 @@ module RapGenius
       parser   NokogiriParser
       base_uri 'http://rapgenius.com'
       headers  'User-Agent' => "rapgenius.rb v#{RapGenius::VERSION}"
+
+      # Perform a search
+      #
+      # query - Query string
+      #
+      # Note: Currently only supports Song searching
+      #
+      # Returns a non-parsed (i.e., plaintext) response body
+      def self.search(query)
+        response = get("/search/quick", query: {q: query}, headers: default_search_headers)
+        response.body
+      end
+
+      private
+
+      # Default headers for a search request
+      #
+      # Tells RapGenius we only want Javascript so we get plaintext results back.
+      def self.default_search_headers
+        {
+          'X-Requested-With' => 'XMLHttpRequest',
+          'Referer'          => base_uri,
+          'Accept'           => 'application/x-javascript,text/javascript'
+        }
+      end
     end
 
     BASE_URL = Client.base_uri + "/".freeze
@@ -32,7 +57,7 @@ module RapGenius
 
     def url=(url)
       unless url =~ /^https?:\/\//
-        @url = BASE_URL + url
+        @url = BASE_URL + url.gsub(/^\//, '')
       else
         @url = url
       end

data/lib/rapgenius/song.rb

@@ -7,16 +7,35 @@ module RapGenius
       self.new(path)
     end
 
-    def initialize(path)
+    # Search for a song
+    #
+    # query - Song to search for
+    #
+    # Returns an Array of Song objects.
+    def self.search(query)
+      results = Client.search(query)
+
+      results.split("\n").map do |song|
+        info, link, id = song.split('|')
+        artist, title  = info.force_encoding('UTF-8').split(' – ')
+
+        new(link, artist: artist, title: title)
+      end
+    end
+
+    def initialize(path, kwargs = {})
       self.url = path
+
+      @artist = kwargs.delete(:artist)
+      @title  = kwargs.delete(:title)
     end
 
     def artist
-      document.css('.song_title a').text
+      @artist ||= document.css('.song_title a').text
     end
 
     def title
-      document.css('.edit_song_description i').text
+      @title ||= document.css('.edit_song_description i').text
     end
 
     def description

data/lib/rapgenius/version.rb

@@ -1,3 +1,3 @@
 module RapGenius
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/rapgenius.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.name        = "rapgenius"
   s.version     = RapGenius::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Tim Rogers"]
-  s.email       = ["me@timrogers.co.uk"]
-  s.homepage    = "http://timrogers.co.uk"
+  s.authors     = ["Tim Rogers", "Robert Speicher"]
+  s.email       = ["me+rapgenius@timrogers.co.uk", "rspeicher@gmail.com"]
+  s.homepage    = "https://github.com/timrogers/rapgenius"
   s.summary     = %q{A gem for accessing lyrics and explanations on RapGenius.com}
   s.description = %q{Up until until now, to quote RapGenius themselves,
     "working at Rap Genius is the API". With this magical screen-scraping gem,

data/spec/rapgenius/annotation_spec.rb

@@ -13,7 +13,7 @@ module RapGenius
 
     describe "#lyric" do
       it "should have the correct lyric" do
-        annotation.lyric.should eq "You gon' get this rain like it's May weather,"
+        annotation.lyric.should match "You gon' get this rain like it's May weather"
       end
     end
 

data/spec/rapgenius/song_spec.rb

@@ -42,5 +42,22 @@ module RapGenius
         i.url.should eq 'http://rapgenius.com/foobar'
       end
     end
+
+    describe '.search', vcr: {cassette_name: 'song-search-big-sean-control'} do
+      let(:results) { described_class.search('Big Sean Control') }
+
+      it "returns an Array of Songs" do
+        results.should be_an Array
+        results.first.should be_a Song
+      end
+
+      describe 'assigned attributes' do
+        subject { results.first }
+
+        its(:url)    { should eq "http://rapgenius.com/Big-sean-control-lyrics" }
+        its(:artist) { should eq "Big Sean (Ft. Jay Electronica & Kendrick Lamar)" }
+        its(:title)  { should eq "Control" }
+      end
+    end
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rapgenius
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
 - Tim Rogers
+- Robert Speicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2013-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -111,7 +112,8 @@ description: ! "Up until until now, to quote RapGenius themselves,\n    \"workin
   at Rap Genius is the API\". With this magical screen-scraping gem,\n    you can
   access the wealth of data on the internet Talmud in Ruby."
 email:
-- me@timrogers.co.uk
+- me+rapgenius@timrogers.co.uk
+- rspeicher@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -130,13 +132,14 @@ files:
 - lib/rapgenius/version.rb
 - pkg/rapgenius-0.0.1.gem
 - pkg/rapgenius-0.0.2.gem
+- pkg/rapgenius-0.0.3.gem
 - rapgenius.gemspec
 - spec/rapgenius/annotation_spec.rb
 - spec/rapgenius/scraper_spec.rb
 - spec/rapgenius/song_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr.rb
-homepage: http://timrogers.co.uk
+homepage: https://github.com/timrogers/rapgenius
 licenses: []
 post_install_message: 
 rdoc_options: []