myanimelist_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 322a8bcf59174eb6fc400792ec2d5217d034655f
-  data.tar.gz: f93f47d5ff102dca9d61b94bc5838d7eab2dd083
+  metadata.gz: 1fa4b21a58ead4a3db317a408fa16cd4c9458b8b
+  data.tar.gz: faa3237727a3e6e76f621a37a3e0355c6f193a22
 SHA512:
-  metadata.gz: 516a2cfacb909d01e1cdc2f3e92a1e79b519ea075e8f42e200fb10107cd8c9c0f9747142a9dec3eac8b3d3b6cd6ee70d5cf8ae88d99356df570f4a1da3ccc972
-  data.tar.gz: a49ba46023cc1d23b66e85e468bc7fef4b6a7518dcd46c15dfbaedfccfd9760bd8e5f9fe7848954365a156aa58ab29f7e3b770331a83b8aa7d99969c3d582960
+  metadata.gz: a4be1f706bda69b1026a75c6618946a27efba1aedcb3d08c02a406eff1cc09e43b1b0c3fcb4f6a839ae59505853bc128e432bca8fa174cf64b75baf017e0382a
+  data.tar.gz: c503f3de7a1206efc067fca1111f9ce3c6261bd3fe553b9d13838df5c7dcc9554649d604e3d41c98ad2c2ecdcfb5061bfd6b2088d8f4bdb4ffa6e29c6248ea7e

data/.rubocop.yml

@@ -0,0 +1,45 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Include:
+    - 'lib/*'
+
+Metrics/LineLength:
+  Include:
+    - 'lib/*'
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/ColonMethodCall:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-11-14 00:10:52 +0100 using RuboCop version 0.45.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: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'lib/myanimelist_client/search_response.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 42
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Style/ExtraSpacing:
+  Exclude:
+    - 'myanimelist_client.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Style/SpaceAroundOperators:
+  Exclude:
+    - 'myanimelist_client.gemspec'

data/.yardopts

@@ -1 +1 @@
-- LICENSE.txt
+--private - LICENSE.txt

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in myanimelist_client.gemspec

data/README.md

@@ -1,4 +1,7 @@
 # MyAnimeList Client
+[![Gem Version](https://badge.fury.io/rb/myanimelist_client.svg)](https://badge.fury.io/rb/myanimelist_client)
+[![Code Climate](https://codeclimate.com/github/Oli4242/myanimelist_client/badges/gpa.svg)](https://codeclimate.com/github/Oli4242/myanimelist_client)
+
 A gem for the [MyAnimeList.net API](https://myanimelist.net/modules.php?go=api).
 
 For now you can:
@@ -8,7 +11,6 @@ For now you can:
 * [Verify credentials](https://myanimelist.net/modules.php?go=api#verifycred)
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -155,6 +157,9 @@ end
 
 ```
 
+## API Documentation
+[The API documentation at rubydoc.info](http://www.rubydoc.info/github/Oli4242/myanimelist_client/master)
+
 ## Contributing
 Report issues at https://github.com/Oli4242/myanimelist_client.
 
@@ -162,10 +167,11 @@ If you want to make a pull request:
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Write and run the specs before you commit (`rake spec`)
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
+3. Write specs and test your code (`rake spec`)
+4. Try not to offend RuboCop (`rake rubocop`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
 
 ## Thanks
 Thanks to [harveyico](https://github.com/harveyico) for his [myanimelist gem](https://github.com/harveyico/myanimelist), it helped me (I was using it before and its code kinda influenced me).

data/Rakefile

@@ -1,9 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
 YARD::Rake::YardocTask.new
 
-task :default => :spec
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "myanimelist_client"
+require 'bundler/setup'
+require 'myanimelist_client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "myanimelist_client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/myanimelist_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rest-client'
 require 'nokogiri'
 

data/lib/myanimelist_client/myanimelist_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This is the main class. It represents a client that can consume the {https://myanimelist.net/modules.php?go=api MyAnimeList.net API}.
 #
 # It allows to search for anime and manga titles as well as verify your username / password.
@@ -52,17 +53,15 @@ class MyanimelistClient
   # @return [UserResponse] The API response or the error message nicely wraped in an object.
   #
   def verify_credentials
-    begin
-      response = RestClient::Request.execute(
-        method:  :get,
-        url:     'https://myanimelist.net/api/account/verify_credentials.xml',
-        user:     @username,
-        password: @password
-      )
-      UserResponse.new response.body
-    rescue RestClient::ExceptionWithResponse => e
-      UserResponse.new e.response.body
-    end
+    response = RestClient::Request.execute(
+      method:  :get,
+      url:     'https://myanimelist.net/api/account/verify_credentials.xml',
+      user:     @username,
+      password: @password
+    )
+    UserResponse.new response.body
+  rescue RestClient::ExceptionWithResponse => e
+    UserResponse.new e.response.body
   end
 
   # Allows to search anime titles.
@@ -71,18 +70,7 @@ class MyanimelistClient
   # @return [SearchResponse] The API response or the error message nicely wraped in an object.
   #
   def search_anime query
-    begin
-      escaped_query = CGI::escape query
-      response = RestClient::Request.execute(
-        method:  :get,
-        url:     "https://myanimelist.net/api/anime/search.xml?q=#{escaped_query}",
-        user:     @username,
-        password: @password
-      )
-      SearchResponse.new response.body
-    rescue RestClient::ExceptionWithResponse => e
-      SearchResponse.new e.response.body, :error
-    end
+    search 'anime', query
   end
 
   # Allows to search manga titles.
@@ -91,17 +79,31 @@ class MyanimelistClient
   # @return [SearchResponse] The API response or the error message nicely wraped in an object.
   #
   def search_manga query
-    begin
-      escaped_query = CGI::escape query
-      response = RestClient::Request.execute(
-        method:  :get,
-        url:     "https://myanimelist.net/api/manga/search.xml?q=#{escaped_query}",
-        user:     @username,
-        password: @password
-      )
-      SearchResponse.new response.body
-    rescue RestClient::ExceptionWithResponse => e
-      SearchResponse.new e.response.body, :error
+    search 'manga', query
+  end
+
+  private
+
+  # Search a manga or an anime depending on the provided type
+  # @param [String] type  The search type (+'anime'+ or +'manga'+).
+  # @param [String] query The search query.
+  # @return [SearchResponse] The API response or the error message nicely wraped in an object.
+  #
+  def search type, query
+    if type != 'anime' && type != 'manga'
+      raise 'Invalid search type: must be anime or manga'
     end
+    escaped_query = CGI::escape query
+    response = RestClient::Request.execute(
+      method:  :get,
+      url:     "https://myanimelist.net/api/#{type}/search.xml?q=#{escaped_query}",
+      user:     @username,
+      password: @password
+    )
+    SearchResponse.new response.body
+  rescue RestClient::ExceptionWithResponse => e
+    SearchResponse.new e.response.body, :error
+  rescue RuntimeError => e
+    SearchResponse.new e.message, :error
   end
 end

data/lib/myanimelist_client/search_entry.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class is used to reprensent an entry within a {SearchResponse}. It can describe either an anime or a manga.
 #
 # @example
@@ -51,7 +52,6 @@
 # @attr [String, nil] image      Returns the image's URL.
 #
 class MyanimelistClient::SearchEntry
-
   # The list of attributes defining the entry for internal usage.
   ATTRIBUTES = %w(
     id
@@ -83,7 +83,7 @@ class MyanimelistClient::SearchEntry
   # Creates a hash representing the entry.
   # @return [Hash]
   def to_h
-    values = ATTRIBUTES.map{|attribute| send attribute }
+    values = ATTRIBUTES.map{ |attribute| send attribute }
     Hash[ATTRIBUTES.zip values]
   end
 
@@ -99,12 +99,12 @@ class MyanimelistClient::SearchEntry
 
   # Returns +true+ when the entry describes an anime.
   def anime?
-    !!@episodes
+    @episodes.to_i > 0
   end
 
   # Returns +true+ when the entry describes a manga.
   def manga?
-    !!(@chapters && @volumes)
+    @chapters.to_i > 0 || @volumes.to_i > 0
   end
 
   # Returns +true+ when the anime is not yet aired / when the manga is not yet published.

data/lib/myanimelist_client/search_response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class represents a response to a search request. It is returned by {#search_anime} and {#search_manga}.
 #
 # +SearchResponse+ is responsible for parsing and wraping the XML response from the myanimelist API (or the error message).
@@ -96,7 +97,7 @@ class MyanimelistClient::SearchResponse
     @entries.size
   end
 
-  alias_method :size, :length
+  alias size length
 
   # Is it empty?
   def empty?

data/lib/myanimelist_client/user_response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This class represents a User. It is returned by {#verify_credentials}.
 #
 # +UserResponse+ is responsible for parsing and wraping the XML (or any error message) from the API.

data/lib/myanimelist_client/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 class MyanimelistClient
   # Versioning.
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/myanimelist_client.gemspec

@@ -1,42 +1,43 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'myanimelist_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "myanimelist_client"
+  spec.name          = 'myanimelist_client'
   spec.version       = MyanimelistClient::VERSION
-  spec.authors       = ["Oli4242"]
-  spec.email         = ["Oli4242@users.noreply.github.com"]
+  spec.authors       = ['Oli4242']
+  spec.email         = ['Oli4242@users.noreply.github.com']
 
-  spec.summary       = %q{A client for the MyAnimeList.net API}
-  # spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = "https://github.com/Oli4242/myanimelist_client"
-  spec.license       = "MIT"
+  spec.summary       = 'A client for the MyAnimeList.net API'
+  spec.homepage      = 'https://github.com/Oli4242/myanimelist_client'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'rubocop', '~> 0.45'
 
-  spec.add_dependency "rest-client", "~> 2.0"
-  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.add_dependency 'nokogiri', '~> 1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myanimelist_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Oli4242
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile