myanimelist 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc5b0a10f6c3922cb468f342555e3925c2eb9578
-  data.tar.gz: 9cac784a6cb777eb4157cc9b0312b84d7c6f9214
+  metadata.gz: 1d8e77f05e3680db2d96f13495dbbc870175a193
+  data.tar.gz: 05e0f5c18412229addebb096510fcaceb921e3d0
 SHA512:
-  metadata.gz: 0d2140578e69db11756420d7a645f327ba50afa1a56d669410917dc2764875e09351e2b5be653f1f2b51c67960bf8eea5f4238e047b56c594a25fa57cad36bd0
-  data.tar.gz: 18f71448dbd0e3432ae1f4ef9dbd8bab22c51ec3ba19a65021766bc5dfffc1a3387d7b239b5e617efe8cf3bc4e3dbd7b3048dfabf890cb61e52827ff023b8cc0
+  metadata.gz: bc7812a458ecae48e37ee8e4f5eea3465cc3a0c02b196f8b25d99ac2b79357beeb2136e44d6c0aac02a6bc22f97520274a1750d0834173d4e5f5abd8ee94d650
+  data.tar.gz: 14d83c4cbf80eb1546ccf2f13cf865af985eb1b4d18c4d4a2eeeae966934b9c655540926161c1a06e99978b1edb34a8a914815dcac4b531062702a5cf872b54a

data/README.md

@@ -1,24 +1,46 @@
 # Myanimelist
-
-TODO: Write a gem description
-
+An API for http://myanimelist.net for searching animes and mangas up to date!
+For additional documentation, visit: http://myanimelist.net/modules.php?go=api
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'myanimelist'
+    gem 'myanimelist', '~> 0.0.2'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 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>
+
+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, 
+If you are using Rails: setup `config/initializers/myanimelist.rb`:
+```ruby
+MyAnimeList.configure do |config|
+    config.username = "username"
+    config.password = "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.")
+```
+####For Manga:
+```ruby
+    MyAnimeList.search_manga("Manga name here.")
+```
 
-TODO: Write usage instructions here
+Simple isn't it?
 
 ## Contributing
 
@@ -27,3 +49,6 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## Special Thanks for http://myanimelist.net, That's it, Thanks and have fun :)

data/lib/myanimelist/anime.rb

@@ -13,7 +13,7 @@ module MyAnimeList
     def get_search(name)
       response = RestClient::Request.new(
         method: :get,
-        url: "http://myanimelist.net/api/anime/search.xml?q=#{name}",
+        url: "http://myanimelist.net/api/anime/search.xml?q=#{CGI::escape name}",
         user: @myanimelist_username,
         password: @myanimelist_password,
         content_type: :xml ).execute

data/lib/myanimelist/manga.rb

@@ -13,7 +13,7 @@ module MyAnimeList
     def get_search(name)
       response = RestClient::Request.new(
         method: :get,
-        url: "http://myanimelist.net/api/manga/search.xml?q=#{name}",
+        url: "http://myanimelist.net/api/manga/search.xml?q=#{CGI::escape name}",
         user: @myanimelist_username,
         password: @myanimelist_password,
         content_type: :xml ).execute

data/lib/myanimelist/version.rb

@@ -1,3 +1,3 @@
 module Myanimelist
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/myanimelist.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['godstrikerharvey@gmail.com']
   spec.description   = %q{The API for MyAnimeList.net}
   spec.summary       = %q{This gem will helps you to make your life easier and better :)}
-  spec.homepage      = 'http://myanimelist.net'
+  spec.homepage      = 'https://github.com/sanzo12/myanimelist'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myanimelist
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Harvey Ico
@@ -84,7 +84,7 @@ files:
 - lib/myanimelist/manga.rb
 - lib/myanimelist/version.rb
 - myanimelist.gemspec
-homepage: http://myanimelist.net
+homepage: https://github.com/sanzo12/myanimelist
 licenses:
 - MIT
 metadata: {}