genius 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99591718ba879a8d777a77d36774ba38902a5fc2
-  data.tar.gz: 611a7e528d428f6ff2d539f5163a9f7481aa7d11
+  metadata.gz: c727308708c8f45cbb85934762b28cdb8f3c6c5a
+  data.tar.gz: b9b7651fd5ddd04fd300a57a825d9c03eeaad0c9
 SHA512:
-  metadata.gz: bb7182b7640f26ed6b7cde30fd3004968ce89ee4374b1355c5ca6aadfb5cca3f94f7e620928bb1885ee006b4978263087f84d0cbb8c8d46f9dd72170c9f1485a
-  data.tar.gz: 71f6e64bd982c826384c99a07ad5dbff0263ae3052ed8d145532001363baf99d5fc0f0531e44a15bbef9bd72f185aec5dfa2b4f5e0d8a3fcdcb836d6ddccd6e7
+  metadata.gz: b4669440fe4adf3bd25692f09063bbff7b7ca62b9308d86c1578a503a68ccb38a50b9c4ff4510099abdfedd0cbe91beb51d073212a83a4c81d1b9ab675c47f8d
+  data.tar.gz: e372cebf483d5d86f033a611a8f3446c293441c8fbf17b0710e6d38f6bbb29f0e57195176ba8ca662019d88283bf907bf7d7a42cf450fd66b8fc684fb7c9ecbe

data/.rubocop.yml

@@ -0,0 +1,56 @@
+# For all options see https://github.com/bbatsov/rubocop/tree/master/config
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  RunRailsCops: false
+  Include:
+    - Rakefile
+  Exclude:
+    - .*/**/*
+
+# Limit lines to 80 characters.
+LineLength:
+  Max: 90
+
+ClassLength:
+  Enabled: false
+
+ModuleLength:
+  Enabled: false
+
+# Avoid methods longer than 30 lines of code
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 87
+
+# Avoid single-line methods.
+SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+StringLiterals:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false # We use them Redis + StatsD (though maybe we shouldn't?)
+
+# Wants underscores in all large numbers. Pain in the ass for things like
+# unix timestamps.
+NumericLiterals:
+  Enabled: false
+
+# Wants you to use the same argument names for every reduce. This seems kinda
+# naff compared to naming them semantically
+SingleLineBlockParams:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: 'only_raise'
+
+# Use trailing rather than leading dots on multi-line call chains
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Allow non-ASCII characters (e.g. £) in comments
+Style/AsciiComments:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,117 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-06 22:47:07 +0100 using RuboCop version 0.32.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 50
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Offense count: 187
+Metrics/AbcSize:
+  Max: 61
+
+# Offense count: 26
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 11
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 12
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 164
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+Style/AlignHash:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 128
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 21
+# Cop supports --auto-correct.
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+# Offense count: 13
+# Cop supports --auto-correct.
+# Configuration parameters: Keywords.
+Style/CommentAnnotation:
+  Enabled: false
+
+# Offense count: 743
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 9
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 109
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 48
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentHash:
+  Enabled: false
+
+# Offense count: 70
+# Cop supports --auto-correct.
+Style/Lambda:
+  Enabled: false
+
+# Offense count: 577
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Offense count: 21
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/Proc:
+  Enabled: false
+
+# Offense count: 173
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Enabled: false
+
+# Offense count: 28
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: MultiSpaceAllowedForOperators.
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
   - 2.2.0
+  - 2.0.0
 before_install: gem install bundler -v 1.10.4
+script:
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.1 (3rd July 2015)
+
+* Support for new Annotations APIs
+
+## 0.1.0 (26th June 2015)
+
+* Initial release

data/README.md

@@ -1,5 +1,8 @@
 # Genius
 
+[![Build Status](https://travis-ci.org/timrogers/genius.svg)](https://travis-ci.org/timrogers/genius)
+[![Gem Version](https://badge.fury.io/rb/genius.svg)](http://badge.fury.io/rb/genius)
+
 ![Genius logo](http://assets.rapgenius.com/images/apple-touch-icon.png?1432674944)
 
 ## What does this do?
@@ -129,13 +132,16 @@ me.iq
 
 Check out [account.rb](https://github.com/timrogers/genius/blob/master/lib/genius/account.rb) or the [Genius API documentation](https://docs.genius.com/#account-h2) for a full list of available fields.
 
+### Other resources
+
+The API library also supports working with web pages, annotations and referents in the API. See the [Genius API documentation](https://docs.genius.com/#account-h2) and the library [source](https://github.com/timrogers/genius/tree/master/lib/genius).
 
 ## Contributing
 
 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`
+* Make sure you write specs, then run them with `$ bundle exec rake`. When running tests, you'll want to set `GENIUS_ACCESS_TOKEN` so your requests can be authenticated - don't worry, your token will be filtered out of the `vcr` cassettes.
 * Update this README.md file so I, and users, know how your changes work
 
 ## Copyright

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/genius.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mocha",     "~> 0.14.0"
   spec.add_development_dependency "webmock",   "~> 1.11.0"
   spec.add_development_dependency "vcr",       "~> 2.5.0"
+  spec.add_development_dependency "rubocop",   "~> 0.31.0"
 
   spec.add_runtime_dependency     "httparty",  "~> 0.11.0"
 end

data/lib/genius/account.rb

@@ -26,7 +26,7 @@ module Genius
       raise NotReloadableError, "An Account cannot be reloaded"
     end
 
-    def self.find(id, params: {}, headers: {})
+    def self.find(*)
       raise NotImplementedError, "An Account cannot be loaded by its ID in the public API"
     end
 
@@ -34,8 +34,9 @@ module Genius
       headers = default_headers.merge(params.delete(:headers) || {})
       params = default_params.merge(params)
 
-      new(http_get("/account", query: params, headers: headers),
-                               text_format: params[:text_format])
+      new(http_get("/account", query: params,
+                               headers: headers),
+          text_format: params[:text_format])
     end
   end
 end

data/lib/genius/annotation.rb

@@ -15,5 +15,44 @@ module Genius
       @id = resource["id"]
       @url = resource["url"]
     end
+
+    def update!(body = {})
+      response = self.class.http_put("/annotations/#{id}",
+                                     body: body,
+                                     headers: self.class.default_headers)
+
+      self.class.new(response, text_format: text_format)
+    end
+
+    def destroy!
+      self.class.http_delete("/annotations/#{id}", headers: self.class.default_headers)
+
+      true
+    end
+
+    def upvote!
+      self.class.http_put("/annotations/#{id}/upvote",
+                          headers: self.class.default_headers)
+
+      true
+    end
+
+    def unvote!
+      self.class.http_put("/annotations/#{id}/unvote",
+                          headers: self.class.default_headers)
+
+      true
+    end
+
+    def downvote!
+      self.class.http_put("/annotations/#{id}/downvote",
+                          headers: self.class.default_headers)
+
+      true
+    end
+
+    def self.create!(body = {})
+      new(http_post("/annotations", body: body, headers: default_headers))
+    end
   end
 end

data/lib/genius/errors.rb

@@ -1,6 +1,7 @@
 module Genius
-  class NotFoundError < StandardError; end
-  class AuthenticationError < StandardError; end
-  class MissingAccessTokenError < StandardError; end
-  class NotReloadableError < StandardError; end
+  class Error < StandardError; end
+  class NotFoundError < Error; end
+  class AuthenticationError < Error; end
+  class MissingAccessTokenError < Error; end
+  class NotReloadableError < Error; end
 end

data/lib/genius/referent.rb

@@ -3,7 +3,7 @@ module Genius
     attr_reader :id, :url, :song_id, :annotator_id, :fragment, :range, :classification,
                 :annotatable, :annotations
 
-    def self.find(id, params: {}, headers: {})
+    def self.find(*)
       raise NotImplementedError, "A Referent cannot be loaded by its ID in the public API"
     end
 

data/lib/genius/resource.rb

@@ -10,10 +10,7 @@ module Genius
     attr_reader :raw_response, :resource
 
     def self.resource_name(resource_name = nil)
-      if resource_name
-        @resource_name = resource_name
-      end
-
+      @resource_name = resource_name if resource_name
       @resource_name || name.downcase.split("::").last
     end
 
@@ -21,8 +18,10 @@ module Genius
       params = default_params.merge(params)
       headers = default_headers.merge(headers)
 
-      new(http_get("/#{resource_name}s/#{id}", query: params, headers: headers),
-                   text_format: params[:text_format])
+      new(http_get("/#{resource_name}s/#{id}",
+                   query: params,
+                   headers: headers),
+          text_format: params[:text_format])
     end
 
     def reload
@@ -31,7 +30,25 @@ module Genius
 
     def self.http_get(path, query: {}, headers: {})
       response = get(path, query: query, headers: headers)
+      handle_response(response)
+    end
+
+    def self.http_post(path, body: {}, headers: {})
+      response = post(path, body: body, headers: headers)
+      handle_response(response)
+    end
+
+    def self.http_put(path, body: {}, headers: {})
+      response = put(path, body: body, headers: headers)
+      handle_response(response)
+    end
+
+    def self.http_delete(path, headers: {})
+      response = delete(path, headers: headers)
+      handle_response(response)
+    end
 
+    def self.handle_response(response)
       case response.code
       when 404 then raise NotFoundError
       when 401, 403 then raise AuthenticationError

data/lib/genius/version.rb

@@ -1,3 +1,3 @@
 module Genius
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/genius/web_page.rb

@@ -14,7 +14,7 @@ module Genius
       @annotation_count = resource["annotation_count"]
     end
 
-    def self.find(id, params: {}, headers: {})
+    def self.find(*)
       raise NotImplementedError, "A Web Page cannot be loaded by its ID in the public API"
     end
 
@@ -26,8 +26,10 @@ module Genius
       headers = default_headers.merge(params.delete(:headers) || {})
       params = default_params.merge(params)
 
-      new(http_get("/#{resource_name}s/lookup", query: params, headers: headers),
-                                                text_format: params[:text_format])
+      new(http_get("/#{resource_name}s/lookup",
+                   query: params,
+                   headers: headers),
+          text_format: params[:text_format])
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: genius
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tim Rogers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +145,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt