rapgenius 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dc98c505e166b321df324c14c7a90d443070452
-  data.tar.gz: 281d8fa2c6c642a0b02cac49f4c296f95d912966
+  metadata.gz: b1640ae0f92fe785852dc5299ea740898c45e9ee
+  data.tar.gz: 87ca2d685134998e741566bf36fb84b2be5b28b2
 SHA512:
-  metadata.gz: 4ee1fcfd58f2c942912be1100dc9794f08c32fd82874f075cacdc26911802b54acbc144dae269d9391d5bf2f35c975d63ddca80f377f8ad0bf8ed00b4069000a
-  data.tar.gz: 208a5872b109172add3473b3832bc4759a6264c9add291d3e170d7d80b7b0c856b21bea193c57bcba5cba273b9ef8a99b9cf6dcb745c54100ff68a57a73f4994
+  metadata.gz: 94087dcf9563c729aa0a125e12c6ddb155c02497977c96ec6a349a8d1b7efeaa00fb565e6e0a725d5c74f5cf22b4a95bff9aade34bf7f04a1d23f1497a594d9f
+  data.tar.gz: 8ea1e7629947d329f0e07bb1537086fd757aa1adbfa2df7b59f91abe75cf2f0df42d1cd4ce9796b3ee6806985aa918a38607862d6324b6c583683be411c1640f

data/CHANGELOG.md

@@ -39,4 +39,8 @@ __v1.0.4__ (8th November 2014)
 
 __v1.0.5__ (12th January 2015)
 
-* Load descriptions as plain text, reducing code for parsing them
+* Load descriptions as plain text, reducing code for parsing them
+
+__v1.1.0__ (5th June 2015)
+
+* Authenticate using access tokens for the official [Genius API](https://docs.genius.com)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2014 Tim Rogers
+Copyright (c) 2013-2015 Tim Rogers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/README.md

@@ -1,27 +1,41 @@
-# rapgenius.rb
+# rapgenius
 
-![Rap Genius logo](http://f.cl.ly/items/303W0c1i2r100j2u3Y0y/Screen%20Shot%202013-08-17%20at%2016.01.19.png)
+![Rap Genius logo](http://assets.rapgenius.com/images/apple-touch-icon.png?1432674944)
 
 ## What does this do?
 
-It's a Ruby gem for accessing lyrics, artists and explanations on
-[Rap Genius](http://rapgenius.com).
+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 Rap Genius's pages,
-but no more. The new [Genius iOS app](http://rapgenius.com/static/app) uses
-a private API, which this gem makes use of.
+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:
 
-`gem "rapgenius", "~> 1.0.5"`
+```ruby
+gem "rapgenius", "~> 1.1.0"
+```
 
 ## Usage
 
 __The best way to get a decent idea of the attributes available on `Song` and
-the other objects is by looking through the files in `lib/rapgenius`.__
+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
+
+From there, you can also generate a client access token and use it like so:
+
+``` ruby
+RapGenius::Client.access_token = 'your-access-token'
+```
 
 ### Searching
 
@@ -71,7 +85,6 @@ song.description
 # => "Released in June 2013, not only did they take the beat from Soulja Boy’s OMG part 2 but they absolutely killed it."
 ```
 
-
 ### Lines
 
 Once you've got a song, you can then go through its "lines", which includes
@@ -151,7 +164,7 @@ If you'd like to contribute anything else, go ahead or better still, make an iss
 
 ## Copyright
 
-Copyright (c) 2013-2014 Tim Rogers. See LICENSE for details.
+Copyright (c) 2013-2015 Tim Rogers. See LICENSE for details.
 
 ## Get in touch
 

data/lib/rapgenius/client.rb

@@ -2,12 +2,15 @@ require 'httparty'
 
 module RapGenius
   module Client
+    class << self
+      attr_accessor :access_token
+    end
+
     class HTTPClient
       include HTTParty
 
       format   :json
       base_uri 'https://api.rapgenius.com'
-      headers  'User-Agent' => "rapgenius.rb v#{RapGenius::VERSION}"
     end
 
     BASE_URL = HTTPClient.base_uri + "/".freeze
@@ -31,6 +34,9 @@ module RapGenius
     def fetch(url)
       response = HTTPClient.get(url, query: {
         text_format: "#{DOM_TEXT_FORMAT},#{PLAIN_TEXT_FORMAT}"
+      }, headers: {
+        'Authorization' => "Bearer #{RapGenius::Client.access_token}",
+        'User-Agent' => "rapgenius.rb v#{RapGenius::VERSION}"
       })
 
       if response.code != 200

data/lib/rapgenius/version.rb

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

data/rapgenius.gemspec

@@ -9,11 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Tim Rogers"]
   s.email       = ["me@timrogers.co.uk"]
   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 gem using the
-    private API in the 'Genius' iOS app you can access the wealth of data on
-    the internet Talmud in Ruby.}
+  s.summary     = %q{A gem for accessing texts and explanations on Genius.com}
 
   s.add_runtime_dependency "httparty",    "~>0.11.0"
   s.add_development_dependency "rspec",   "~>2.14.1"

data/spec/rapgenius/client_spec.rb

@@ -25,6 +25,21 @@ module RapGenius
       end
     end
 
+    describe '.access_token=' do
+      let(:access_token) { 'my-access-token' }
+
+      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}"})
+      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" }
 

metadata

@@ -1,97 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: rapgenius
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
-description: |-
-  Up until until now, to quote RapGenius themselves,
-      "working at Rap Genius is the API". With this magical gem using the
-      private API in the 'Genius' iOS app you can access the wealth of data on
-      the internet Talmud in Ruby.
+description: 
 email:
 - me@timrogers.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -130,20 +126,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
-summary: A gem for accessing lyrics and explanations on RapGenius.com
+summary: A gem for accessing texts and explanations on Genius.com
 test_files:
 - spec/rapgenius/artist_spec.rb
 - spec/rapgenius/client_spec.rb