myanimelist 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ee360b5bd08a49364d81064109805a61cc58d8
-  data.tar.gz: 6dce9b0faaae0d0aaec913d0c8914118fc19cba9
+  metadata.gz: 36e2394e2cc00a68cf29f2a2f415c7d18496b2e6
+  data.tar.gz: de27746feff083309417341a421a3d93a5cdc5e6
 SHA512:
-  metadata.gz: 808261cb089aeaa457579bfade0b3473cbb3d2d34d46fbd47a8e0539a7dfeba93cd4f59b27ff6399151c76f52b0bd23798e847013c8a45329b5e5b93e7e708ef
-  data.tar.gz: 64dd32a27dd3a9d7e8d9580502fcd5aaadc07768d6613c23a6fff4a1a4c59f2c8d5dd8556670c10b1ebcecba720f2d50f7ebaf6b6ee41e89fa00c8f42567cef5
+  metadata.gz: 04ccd0576989e8c6db19870d5acfc86b6c68773464886d8082d1e1d27aff5d944eaec30658c0a751cc169050f50200968ce92692272077534ad886b1d1f15930
+  data.tar.gz: 496e664055f874ac4ef857c7f08e211bc2cab5e3bddbb7eee3b23e35bde8526243e026ef510daf319c7a9274b4499b1815f3950473a703206e160c17a5458d46

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -1,11 +1,12 @@
 # MyAnimeList
-An API for http://myanimelist.net for searching animes and mangas up to date!
+A gem wrapper for http://myanimelist.net that covers all the methods available on the current API
 For additional documentation, visit: http://myanimelist.net/modules.php?go=api
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'myanimelist', '~> 0.0.6'
+    gem 'myanimelist', '~> 1.0'
 
 And then execute:
 
@@ -16,50 +17,94 @@ Or install it yourself as:
     $ gem install myanimelist
 
 ### Configuration
-MyAnimeList API requires authentication from the actual site, so you need to sign up first 
-<a href="http://myanimelist.net/register.php">here</a>
+MyAnimeList API requires authentication from the actual site, so you need to sign up first [here](http://myanimelist.net/register.php).
 
 After signing up and verifying your email, you need to assign the username and password on your respective myanimelist API,
-here's what you need to do, 
+here's what you need to do,
 If you are using Rails: setup `config/initializers/myanimelist.rb`:
 ```ruby
 MyAnimeList.configure do |config|
-    config.username = "username"
-    config.password = "password"
+    config.username = ENV['username']
+    config.password = ENV['password']
 end
 ```
 If you are not using rails make sure to set this up before you can start searching.
 
 ## Usage
-#####For Anime:
-```ruby
-    MyAnimeList.search_anime("Anime name here.")
+#### Verify Credentials
+Additional step for verifying credentials from myanimelist.
 ```
-####For Manga:
-```ruby
-    MyAnimeList.search_manga("Manga name here.")
+MyAnimeList.verify_crendetials
 ```
 
-Simple isn't it?
+#### Search Anime/Manga
+Returns an Array of Hashes for the result.
+```
+# Anime
+> MyAnimeList.search_anime('Fairy Tail')
+> MyAnimeList::Anime.search('Fairy Tail')
+
+# Manga
+> MyAnimeList.search_manga('Fairy Tail')
+> MyAnimeList::Manga.search('Fairy Tail'
+```
 
-##Example
+#### Add Anime/Manga
+Adds anime/manga on your list. For additional `Anime` parameters, please refer [here](https://myanimelist.net/modules.php?go=api#animevalues). For `Manga`, please refer [here](https://myanimelist.net/modules.php?go=api#mangavalues).
+Just imagine that the xml value would be the key:value pair in ruby, as seen below.
+```
+# Anime
+> MyAnimeList::Anime.add(anime_id, { episode: 1, status: 2 })
+=> true
+
+# Manga
+> MyAnimeList::Manga.add(manga_id, { chapter: 1 })
+=> true
+```
+
+#### Update Anime/Manga
+Updates anime/manga on your list. For additional `Anime` parameters, please refer [here](https://myanimelist.net/modules.php?go=api#animevalues). For `Manga`, please refer [here](https://myanimelist.net/modules.php?go=api#mangavalues).
+Just imagine that the xml value would be the key:value pair in ruby, as seen below.
+```
+# Anime
+> MyAnimeList::Anime.update(anime_id, { episode: 1, status: 2 })
+=> true
+
+# Manga
+> MyAnimeList::Manga.update(manga_id, { chapter: 1 })
+=> true
+```
+
+#### Remove Anime/Manga
+Remove anime/manga on your list.
+```
+# Anime
+> MyAnimeList::Anime.remove(anime_id)
+=> true
+
+# Manga
+> MyAnimeList::Manga.remove(manga_id)
+=> true
+```
+
+## Example
 ```ruby
     MyAnimeList.search_anime('Fairy Tail')
-    
-    #will result to the followinghash
-    
-    =>   [{"id"=>"6702", 
-            "title"=>"Fairy Tail", 
-            "english"=>nil, 
-            "synonyms"=>nil, 
-            "episodes"=>"175", 
-            "score"=>"8.57", 
-            "type"=>"TV", 
-            "status"=>"Finished Airing", 
-            "start_date"=>"2009-10-12", 
-            "end_date"=>"2013-03-30", 
+
+    # will result to the followinghash
+
+    =>   [{"id"=>"6702",
+            "title"=>"Fairy Tail",
+            "english"=>nil,
+            "synonyms"=>nil,
+            "episodes"=>"175",
+            "score"=>"8.57",
+            "type"=>"TV",
+            "status"=>"Finished Airing",
+            "start_date"=>"2009-10-12",
+            "end_date"=>"2013-03-30",
             "synopsis"=>
-                  "Set in an imaginary world, the Earth Land, there exists a Mage Guild called Fairy Tail...", 
+                  "Set in an imaginary world, the Earth Land, there exists a Mage Guild called Fairy Tail...",
             "image"=>"http://cdn.myanimelist.net/images/anime/5/18179.jpg"}
         }]
 
@@ -74,4 +119,9 @@ Simple isn't it?
 5. Create new Pull Request
 
 
-## Special Thanks for http://myanimelist.net, That's it, Thanks and have fun :)
+## Thanks
+[MyAnimeList](myanimelist.net) for the API.
+
+**myanimelist** © 2013+, Harvey Ico. Released under the [MIT](http://mit-license.org/) License.
+
+Authored and maintained by Harvey Ico with help from contributors ([list](https://github.com/harveyico/myanimelist/contributors)).

data/lib/myanimelist.rb

@@ -1,6 +1,7 @@
+require 'rest-client'
+require 'xmlsimple'
 require 'myanimelist/version'
-require 'rest_client'
-require 'active_support/core_ext/hash'
+require 'myanimelist/api'
 require 'myanimelist/anime'
 require 'myanimelist/manga'
 require 'myanimelist/credentials'
@@ -8,21 +9,18 @@ require 'myanimelist/serializer'
 
 module MyAnimeList
   def self.configure(&block)
-    credentials = Credentials.new
-    block.call(credentials)
-    @myanimelist_username = credentials.username
-    @myanimelist_password = credentials.password
+    block.call(Credentials) if block_given?
+  end
 
-    true if block_given?
+  def self.verify_credentials
+    Api.new.verify_credentials!
   end
 
   def self.search_anime(name)
-    animes = Anime.new(username: @myanimelist_username, password: @myanimelist_password)
-    animes.search name
+    MyAnimeList::Anime.search(name)
   end
 
   def self.search_manga(name)
-    manga = Manga.new(username: @myanimelist_username, password: @myanimelist_password)
-    manga.search name
+    MyAnimeList::Manga.search(name)
   end
 end

data/lib/myanimelist/anime.rb

@@ -1,34 +1,19 @@
 module MyAnimeList
   class Anime
-
-    def initialize(options={})
-      @myanimelist_username = options[:username]
-      @myanimelist_password = options[:password]
+    def self.search(name)
+      Api.new.search('anime', name)
     end
 
-    def search(name)
-      get_search(name)
+    def self.add(id, params = {})
+      Api.new.add('anime', id,  params)
     end
 
-    def get_search(name)
-      response = RestClient::Request.new(
-        method: :get,
-        url: "https://myanimelist.net/api/anime/search.xml?q=#{CGI::escape name}",
-        user: @myanimelist_username,
-        password: @myanimelist_password,
-        content_type: :xml ).execute
-
-      parse_xml response
+    def self.update(id,  params = {})
+      Api.new.update('anime', id,  params)
     end
 
-    def parse_xml(response)
-      serialize Hash.from_xml response
+    def self.remove(id)
+      Api.new.remove('anime', id)
     end
-
-    def serialize(data)
-      result = MyAnimeList::Serializer.new data, 'anime'
-      result.fetch
-    end
-
   end
 end

data/lib/myanimelist/api.rb

@@ -0,0 +1,63 @@
+module MyAnimeList
+  class ApiException < Exception; end
+  class Api
+    BASE_URL = 'https://myanimelist.net/api'
+
+    def search(type, name)
+      body = request("#{BASE_URL}/#{type}/search.xml?q=#{CGI::escape name}")
+
+      Serializer.new(body).entry
+    end
+
+    def add(type, id, params = {})
+      request("#{BASE_URL}/#{type}list/add/#{id}.xml", params) == 'Created'
+    end
+
+    def update(type, id, params = {})
+      request("#{BASE_URL}/#{type}list/update/#{id}.xml", params) == 'Updated'
+    end
+
+    def remove(type, id)
+      request("#{BASE_URL}/#{type}list/delete/#{id}.xml") == 'Deleted'
+    end
+
+    def verify_credentials!
+      body = request("#{BASE_URL}/account/verify_credentials.xml")
+
+      Serializer.new(body).call
+    end
+
+    private
+
+    def request(url, params = {})
+      RestClient::Request.new( build_params(url, params) ).execute do |resp|
+        if resp.code == 200 || resp.code == 201
+          resp.body
+        else
+          raise ApiException.new(resp.body)
+        end
+      end
+    end
+
+    def build_params(url, params)
+      {
+        method: :get,
+        url: url,
+        user: Credentials.username,
+        password: Credentials.password,
+        content_type: :xml
+      }.merge( headers(params) )
+    end
+
+    def headers(params)
+      return {} if params.empty?
+      {
+        headers: {
+          params: {
+            data: XmlSimple.xml_out(params, rootname: 'entry', noattr: true, noindent: true, keeproot: false)
+          }
+        }
+      }
+    end
+  end
+end

data/lib/myanimelist/credentials.rb

@@ -1,6 +1,8 @@
 module MyAnimeList
   class Credentials
-    attr_accessor :username
-    attr_accessor :password
+    class << self
+      attr_accessor :username
+      attr_accessor :password
+    end
   end
 end

data/lib/myanimelist/manga.rb

@@ -1,34 +1,19 @@
 module MyAnimeList
-  class Manga
-
-    def initialize(options={})
-      @myanimelist_username = options[:username]
-      @myanimelist_password = options[:password]
+  class Manga < Api
+    def self.search(name)
+      Api.new.search('manga', name)
     end
 
-    def search(name)
-      get_search(name)
+    def self.add(id, params = {})
+      Api.new.add('manga', id,  params)
     end
 
-    def get_search(name)
-      response = RestClient::Request.new(
-        method: :get,
-        url: "https://myanimelist.net/api/manga/search.xml?q=#{CGI::escape name}",
-        user: @myanimelist_username,
-        password: @myanimelist_password,
-        content_type: :xml ).execute
-
-      parse_xml response
+    def self.update(id,  params = {})
+      Api.new.update('manga', id,  params)
     end
 
-    def parse_xml(response)
-      serialize Hash.from_xml response
+    def self.remove(id)
+      Api.new.remove('manga', id)
     end
-
-    def serialize(data)
-      result = MyAnimeList::Serializer.new data, 'manga'
-      result.fetch
-    end
-
   end
 end

data/lib/myanimelist/serializer.rb

@@ -1,29 +1,18 @@
 module MyAnimeList
   class Serializer
-    def initialize(data, type)
-      @type = type
-      @animes = data || []
-    end
+    attr_accessor :response
 
-    def fetch
-      serialize_data
+    def initialize(resp)
+      @response = resp
     end
 
-    def serialize_data
-      return @animes if is_array? @animes
-
-      collection = []
-      data = @animes[@type]['entry']
-      if is_array? data
-        collection += data
-      else
-        collection << data
-      end
+    def entry
+      hash = XmlSimple.xml_in(response, force_array: false)
+      hash['entry']
     end
 
-    def is_array?(data)
-      data.is_a? Array
+    def call
+      XmlSimple.xml_in(response, force_array: false)
     end
-
   end
 end

data/lib/myanimelist/version.rb

@@ -1,3 +1,3 @@
-module Myanimelist
-  VERSION = '0.0.6'
+module MyAnimeList
+  VERSION = '1.0.0'
 end

data/myanimelist.gemspec

@@ -5,7 +5,7 @@ require 'myanimelist/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'myanimelist'
-  spec.version       = Myanimelist::VERSION
+  spec.version       = MyAnimeList::VERSION
   spec.authors       = ['Harvey Ico']
   spec.email         = ['godstrikerharvey@gmail.com']
   spec.description   = %q{The API for MyAnimeList.net}
@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_dependency 'rest-client'
-  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'bundler', '1.3'
+  spec.add_development_dependency 'rake', '12.0.0'
+  spec.add_dependency 'rest-client', '2.0.2'
+  spec.add_dependency 'xml-simple', '1.1.5'
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: myanimelist
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Harvey Ico
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.5
 description: The API for MyAnimeList.net
 email:
 - godstrikerharvey@gmail.com
@@ -80,6 +80,7 @@ files:
 - Rakefile
 - lib/myanimelist.rb
 - lib/myanimelist/anime.rb
+- lib/myanimelist/api.rb
 - lib/myanimelist/credentials.rb
 - lib/myanimelist/manga.rb
 - lib/myanimelist/serializer.rb