rapgenius 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1640ae0f92fe785852dc5299ea740898c45e9ee
-  data.tar.gz: 87ca2d685134998e741566bf36fb84b2be5b28b2
+  metadata.gz: ce3e59fc79a8548ed3c7a686fb05ff36cbc59f23
+  data.tar.gz: 9539c9a6a3bbb748294ee5f0b159cd3afe24aec8
 SHA512:
-  metadata.gz: 94087dcf9563c729aa0a125e12c6ddb155c02497977c96ec6a349a8d1b7efeaa00fb565e6e0a725d5c74f5cf22b4a95bff9aade34bf7f04a1d23f1497a594d9f
-  data.tar.gz: 8ea1e7629947d329f0e07bb1537086fd757aa1adbfa2df7b59f91abe75cf2f0df42d1cd4ce9796b3ee6806985aa918a38607862d6324b6c583683be411c1640f
+  metadata.gz: b62978657e0ba5d0f829b49ef32ded2507da2d14294390717647be42d5d055d7ea8c5279f0525094d1a3bacdbfeaba19e9653785ef2f7fd92d78e856a8eb0cc4
+  data.tar.gz: 427cf0a58cba5426dd101475b3895e620943980a36e79ad56b1a24e323ab418301f15bbb5d633a5889b893f9da79f0c2e666c6cdd7f834cd678341e784b79dc6

data/CHANGELOG.md

@@ -44,3 +44,9 @@ __v1.0.5__ (12th January 2015)
 __v1.1.0__ (5th June 2015)
 
 * Authenticate using access tokens for the official [Genius API](https://docs.genius.com)
+
+__v1.1.1__ (15th June 2015)
+
+* Raise a `RapGenius::MissingAccessTokenError` when making a request if no access token has been set
+* Handle authentication failures by raising a `RapGenius::AuthenticationError`
+* Fix search functionality (e.g. `RapGenius.search`) so that your access token is actually sent

data/README.md

@@ -7,29 +7,25 @@
 It's a Ruby gem for accessing songs, artists and annotations on
 [Genius](http://genius.com).
 
-In pre-1.0.0 versions, this gem used Nokogiri to scrape Genius' pages,
-but no more thanks to the new [Genius API](https://docs.genius.com), which this
-gem makes use of.
-
 ## Installation
 
 Install the gem, and you're ready to go. Simply add the following to your
 Gemfile:
 
 ```ruby
-gem "rapgenius", "~> 1.1.0"
+gem "rapgenius", "~> 1.1.1"
 ```
 
 ## Usage
 
-__The best way to get a decent idea of the attributes available on `Song` and
+The best way to get a decent idea of the attributes available on `Song` and
 the other objects is by checking out the API documentation at:
 https://docs.genius.com
 
 ### Authenticating
 
 You can create a client and grab an access token from
-http://genius.com/api-clients
+<http://genius.com/api-clients>.
 
 From there, you can also generate a client access token and use it like so:
 
@@ -37,6 +33,8 @@ From there, you can also generate a client access token and use it like so:
 RapGenius::Client.access_token = 'your-access-token'
 ```
 
+You'll need to have set your token in order to be able to make requests.
+
 ### Searching
 
 You can search for songs by various fields. All of these
@@ -55,7 +53,7 @@ in the API.
 
 ### Songs
 
-Songs on Rap Genius have unique identifiers. They're not especially
+Songs on Genius have unique identifiers. They're not especially
 easy to find, but if you hover over the "pyong" button near the top of the page,
 you'll see the song's ID in the URL. Once you have an ID, you can load a
 song via the API:

data/lib/rapgenius.rb

@@ -9,8 +9,10 @@ require 'rapgenius/exceptions'
 module RapGenius
   extend RapGenius::Client
 
-  def self.search(query, options={})
-    response = Client::HTTPClient.get("/search", query: {q: query}.merge(options))
+  def self.search(query, options = {})
+    response = fetch(build_api_url("/search"), { q: query }.merge(options))
+
+
 
     response["response"]["hits"].map do |song|
       result = song["result"]
@@ -39,4 +41,4 @@ module RapGenius
   def self.search_by_lyrics(query)
     self.search(query, field: "lyrics")
   end
-end
+end

data/lib/rapgenius/client.rb

@@ -21,7 +21,7 @@ module RapGenius
 
     def url=(url)
       unless url =~ /^https?:\/\//
-        @url = BASE_URL + url.gsub(/^\//, '')
+        @url = build_api_url(url)
       else
         @url = url
       end
@@ -31,23 +31,35 @@ module RapGenius
       @document ||= fetch(@url)
     end
 
-    def fetch(url)
+    def fetch(url, params = {})
+      unless RapGenius::Client.access_token
+        raise MissingAccessTokenError, "You must specify an access token by setting " \
+                                       "RapGenius::Client.access_token"
+      end
+
       response = HTTPClient.get(url, query: {
         text_format: "#{DOM_TEXT_FORMAT},#{PLAIN_TEXT_FORMAT}"
-      }, headers: {
+      }.merge(params), headers: {
         'Authorization' => "Bearer #{RapGenius::Client.access_token}",
         'User-Agent' => "rapgenius.rb v#{RapGenius::VERSION}"
       })
 
-      if response.code != 200
-        if response.code == 404
-          raise RapGenius::NotFoundError
-        else
-          raise RapGenius::Error, "Received a #{response.code} HTTP response"
-        end
+      case response.code
+      when 404
+        raise RapGenius::NotFoundError
+      when 401
+        raise RapGenius::AuthenticationError
+      when 200
+        return response.parsed_response
+      else
+        raise RapGenius::Error, "Received a #{response.code} HTTP response"
       end
+    end
+
+    private
 
-      response.parsed_response
+    def build_api_url(path)
+      BASE_URL + path.gsub(/^\//, '')
     end
   end
 end

data/lib/rapgenius/exceptions.rb

@@ -3,6 +3,11 @@ module RapGenius
   end
 
   class NotFoundError < Error
+  end
+
+  class AuthenticationError < Error
+  end
 
+  class MissingAccessTokenError < Error
   end
-end
+end

data/lib/rapgenius/version.rb

@@ -1,3 +1,3 @@
 module RapGenius
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/rapgenius/artist_spec.rb

@@ -1,37 +1,38 @@
 require 'spec_helper'
 
-module RapGenius
-  describe Artist do
-    context "given Drake", vcr: { cassette_name: "artist-130" } do
-      subject(:artist) { described_class.find(130) }
+describe RapGenius::Artist do
+  let(:access_token) { 'my-access-token' }
+  before { RapGenius::Client.access_token = access_token }
 
-      its(:url) { should eq "http://genius.com/artists/Drake" }
-      its(:name) { should eq "Drake" }
-      its(:image) { should eq "http://images.rapgenius.com/6e996fe91d484c626f1b36686cb27d7c.450x253x70.gif" }
-      its(:description) { should include "Drake is part of a generation of new rappers" }
+  context "Drake", vcr: { cassette_name: "artist-130" } do
+    subject(:artist) { described_class.find(130) }
 
-      context "#songs" do
-        subject { artist.songs }
+    its(:url) { should eq "http://genius.com/artists/Drake" }
+    its(:name) { should eq "Drake" }
+    its(:image) { should eq "http://images.rapgenius.com/6e996fe91d484c626f1b36686cb27d7c.450x253x70.gif" }
+    its(:description) { should include "Drake is part of a generation of new rappers" }
 
-        its(:count) { should eq 20 }
-        its(:last) { should be_a Song }
-        its("last.title") { should eq "Amen" }
+    context "#songs" do
+      subject { artist.songs }
+
+      its(:count) { should eq 20 }
+      its(:last) { should be_a RapGenius::Song }
+      its("last.title") { should eq "Amen" }
 
-        context "pagination" do
-          subject { artist.songs(page: 3) }
+      context "pagination" do
+        subject { artist.songs(page: 3) }
 
-          its(:last) { should be_a Song }
-          its(:count) { should eq 20 }
-          its("last.title") { should eq "Champion" }
-        end
+        its(:last) { should be_a RapGenius::Song }
+        its(:count) { should eq 20 }
+        its("last.title") { should eq "Champion" }
       end
+    end
 
-      context "a non-existent artist ID" do
-        subject(:artist) { described_class.find("bahahaha") }
+    context "a non-existent artist ID" do
+      subject(:artist) { described_class.find("bahahaha") }
 
-        it "raises an exception" do
-          expect { artist }.to raise_exception
-        end
+      it "raises an exception" do
+        expect { artist }.to raise_exception
       end
     end
   end

data/spec/rapgenius/client_spec.rb

@@ -8,50 +8,67 @@ class ClientTester
   include RapGenius::Client
 end
 
-module RapGenius
-  describe Client do
+describe RapGenius::Client do
+  let(:client) { ClientTester.new }
 
-    let(:client) { ClientTester.new }
+  let(:access_token) { 'my-access-token' }
+  before { RapGenius::Client.access_token = access_token }
 
-    describe "#url=" do
-      it "forms the URL with the base URL, if the current path is relative" do
-        client.url = "foobar"
-        client.url.should include RapGenius::Client::BASE_URL
-      end
+  describe "#url=" do
+    it "forms the URL with the base URL, if the current path is relative" do
+      client.url = "foobar"
+      client.url.should include RapGenius::Client::BASE_URL
+    end
 
-      it "leaves the URL as it is if already complete" do
-        client.url = "http://foobar.com/baz"
-        client.url.should eq "http://foobar.com/baz"
-      end
+    it "leaves the URL as it is if already complete" do
+      client.url = "http://foobar.com/baz"
+      client.url.should eq "http://foobar.com/baz"
+    end
+  end
+
+  describe '.access_token=' do
+    before do
+      stub_request(:get, 'https://api.rapgenius.com/hello?text_format=dom,plain').
+        with(headers: {'Authorization' => "Bearer #{access_token}",
+                       'User-Agent' => "rapgenius.rb v#{RapGenius::VERSION}"})
+    end
+
+    it 'should send the header' do
+      client.fetch('/hello')
+      assert_requested(:get, 'https://api.rapgenius.com/hello?text_format=dom,plain')
     end
+  end
+
+  describe "#document" do
+    before { client.url = "http://foo.bar" }
 
-    describe '.access_token=' do
-      let(:access_token) { 'my-access-token' }
+    context "no access token" do
+      let(:access_token) { nil }
+
+      it "raises a MissingAccessToken error" do
+        expect { client.document }.to raise_error(RapGenius::MissingAccessTokenError)
+      end
+    end
 
+    context "with a 404 response" do
       before do
-        RapGenius::Client.access_token = access_token
-        stub_request(:get, 'https://api.rapgenius.com/hello?text_format=dom,plain').
-          with(headers: {'Authorization' => "Bearer #{access_token}", 'User-Agent' => "rapgenius.rb v#{RapGenius::VERSION}"})
+        stub_request(:get, "http://foo.bar").with(query: { text_format: "dom,plain" }).
+          to_return({body: '', status: 404})
       end
 
-      it 'should send the header' do
-        client.fetch('/hello')
-        assert_requested(:get, 'https://api.rapgenius.com/hello?text_format=dom,plain')
+      it "raises a ScraperError" do
+        expect { client.document }.to raise_error(RapGenius::NotFoundError)
       end
     end
 
-    describe "#document" do
-      before { client.url = "http://foo.bar" }
-
-      context "with a failed request" do
-        before do
-          stub_request(:get, "http://foo.bar").with(query: { text_format: "dom,plain" }).
-            to_return({body: '', status: 404})
-        end
+    context "with an authentication failure" do
+      before do
+        stub_request(:get, "http://foo.bar").with(query: { text_format: "dom,plain" }).
+          to_return({body: '', status: 401})
+      end
 
-        it "raises a ScraperError" do
-          expect { client.document }.to raise_error(RapGenius::Error)
-        end
+      it "raises a ScraperError" do
+        expect { client.document }.to raise_error(RapGenius::AuthenticationError)
       end
     end
   end

data/spec/rapgenius/line_spec.rb

@@ -1,23 +1,23 @@
 require 'spec_helper'
 
-module RapGenius
-  describe Line, vcr: { cassette_name: "line-2638695" } do
+describe RapGenius::Line, vcr: { cassette_name: "line-2638695" } do
+  let(:line) { described_class.find("2638695") }
+  subject { line }
 
-    let(:line) { described_class.find("2638695") }
-    subject { line }
+  let(:access_token) { 'my-access-token' }
+  before { RapGenius::Client.access_token = access_token }
 
-    its(:id)       { should eq "2638695" }
-    its(:song)     { should be_a Song }
-    its(:lyric) { should eq "Versace, Versace, Medusa head on me like I'm 'luminati" }
-    its("explanations.first") { should include "Versace’s logo is the head of Medusa" }
-    its(:explanations) { should eq line.annotations }
+  its(:id)       { should eq "2638695" }
+  its(:song)     { should be_a RapGenius::Song }
+  its(:lyric) { should eq "Versace, Versace, Medusa head on me like I'm 'luminati" }
+  its("explanations.first") { should include "Versace’s logo is the head of Medusa" }
+  its(:explanations) { should eq line.annotations }
 
-    context "a non-existent referent ID" do
-      let(:line) { described_class.find("bahahaha") }
+  context "a non-existent referent ID" do
+    let(:line) { described_class.find("bahahaha") }
 
-      it "raises an exception" do
-        expect { line }.to raise_exception
-      end
+    it "raises an exception" do
+      expect { line }.to raise_exception
     end
   end
 end

data/spec/rapgenius/media_spec.rb

@@ -1,19 +1,10 @@
 require 'spec_helper'
 
-module RapGenius
-  describe Media do
+describe RapGenius::Media do
+  subject(:media) { described_class.new(type: "foo", url: "foo", provider: "foo") }
 
-    subject(:media) do
-      Media.new(
-        type: "foo",
-        url: "foo",
-        provider: "foo"
-      )
-    end
+  its(:type) { should eq "foo" }
+  its(:url) { should eq "foo" }
+  its(:provider) { should eq "foo" }
 
-    its(:type) { should eq "foo" }
-    its(:url) { should eq "foo" }
-    its(:provider) { should eq "foo" }
-
-  end
-end
+end

data/spec/rapgenius/song_spec.rb

@@ -1,64 +1,65 @@
 require 'spec_helper'
 
-module RapGenius
-  describe Song do
-    context "given Migos's Versace", vcr: { cassette_name: "song-176872" } do
-      subject(:song) { described_class.find(176872) }
+describe RapGenius::Song do
+  context "Migos's Versace", vcr: { cassette_name: "song-176872" } do
+    subject(:song) { described_class.find(176872) }
 
-      its(:url) { should eq "http://genius.com/Migos-versace-lyrics" }
-      its(:title) { should eq "Versace" }
+    let(:access_token) { 'my-access-token' }
+    before { RapGenius::Client.access_token = access_token }
 
-      its(:description) { should include "the song blew up" }
+    its(:url) { should eq "http://genius.com/Migos-versace-lyrics" }
+    its(:title) { should eq "Versace" }
 
-      context "#artist" do
-        subject { song.artist }
-        it { should be_a Artist }
-        its(:name) { should eq "Migos" }
-      end
+    its(:description) { should include "the song blew up" }
 
-      context "#featured_artists" do
-        subject { song.featured_artists }
-        its(:length) { should eq 1 }
-        its("first.name") { should eq "Drake" }
-        its(:first) { should be_a Artist }
-      end
+    context "#artist" do
+      subject { song.artist }
+      it { should be_a RapGenius::Artist }
+      its(:name) { should eq "Migos" }
+    end
 
-      context "#producer_artists" do
-        subject { song.producer_artists }
-        its(:length) { should eq 1 }
-        its("first.name") { should eq "Zaytoven" }
-        its(:first) { should be_a Artist }
-      end
+    context "#featured_artists" do
+      subject { song.featured_artists }
+      its(:length) { should eq 1 }
+      its("first.name") { should eq "Drake" }
+      its(:first) { should be_a RapGenius::Artist }
+    end
 
-      context "#media" do
-        subject { song.media }
-        its(:length) { should eq 2 }
-        its(:first) { should be_a Media }
-        its("first.provider") { should eq "soundcloud" }
-      end
+    context "#producer_artists" do
+      subject { song.producer_artists }
+      its(:length) { should eq 1 }
+      its("first.name") { should eq "Zaytoven" }
+      its(:first) { should be_a RapGenius::Artist }
+    end
 
-      context "#lines" do
-        subject { song.lines }
-        its(:count) { should eq 81 }
-        its(:first) { should be_a Line }
-        its("first.id") { should eq "1983907" }
-        its("first.lyric") { should eq "[Verse 1: Drake]" }
-        its("first.explanations.first") { should include "Versace used his verse in this runway show" }
-      end
+    context "#media" do
+      subject { song.media }
+      its(:length) { should eq 2 }
+      its(:first) { should be_a RapGenius::Media }
+      its("first.provider") { should eq "soundcloud" }
+    end
+
+    context "#lines" do
+      subject { song.lines }
+      its(:count) { should eq 81 }
+      its(:first) { should be_a RapGenius::Line }
+      its("first.id") { should eq "1983907" }
+      its("first.lyric") { should eq "[Verse 1: Drake]" }
+      its("first.explanations.first") { should include "Versace used his verse in this runway show" }
+    end
 
-      its(:images) { should include "http://s3.amazonaws.com/rapgenius/Zaytoven_1-7-2011.jpg" }
-      its(:pyongs) { should eq 166 }
-      its(:hot?) { should eq false }
-      its(:views) { should eq 2159953 }
-      its(:concurrent_viewers) { should be_nil }
+    its(:images) { should include "http://s3.amazonaws.com/rapgenius/Zaytoven_1-7-2011.jpg" }
+    its(:pyongs) { should eq 166 }
+    its(:hot?) { should eq false }
+    its(:views) { should eq 2159953 }
+    its(:concurrent_viewers) { should be_nil }
 
 
-      context "a non-existent song ID" do
-        subject(:song) { described_class.find("bahahaha") }
+    context "a non-existent song ID" do
+      subject(:song) { described_class.find("bahahaha") }
 
-        it "raises an exception" do
-          expect { song }.to raise_exception
-        end
+      it "raises an exception" do
+        expect { song }.to raise_exception
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rapgenius
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Tim Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -102,9 +102,6 @@ files:
 - lib/rapgenius/media.rb
 - lib/rapgenius/song.rb
 - 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/artist_spec.rb
 - spec/rapgenius/client_spec.rb