foxit 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 541b370e85c872627d4bff2419a6af1d8ce922c8e19363218aad0f6642b435ab
-  data.tar.gz: 74738a7174d332d718573188510a6e4744f8b08b7cb66735ae758fadb65dfd1c
+  metadata.gz: 4f2ddc5e34db607cabc25cd0df88a4a1830df59757d2021fd75ef414d6cfc9bd
+  data.tar.gz: 7689130ad6eea5df3f7f7b5a49df55e548890e4513223fa98cfc65b078718f3c
 SHA512:
-  metadata.gz: 4dcfdbcf7d13ec79d4501298fe49379b07fff9736829a42f01ecaee043aa0ccfde9a1bd6861c8ea63bb0824cf6f134a1ec81e9d5f83956388a86420e4d872ca9
-  data.tar.gz: e597208dcabad4affd0ff242bbcec7cddc7ae85afb0f499193d85b82dbf9885a0cb32b2719795907d60608c21c55671ea5daf32c3356ccc4e24b0a2c0f18f974
+  metadata.gz: 9912bb8e912a1b41ee8150c341e4cb75718466058a78193c48835d2cf8d3b2470941015a3820a501daaa5809d906537c36518917cb7d5383f2fafaf922090255
+  data.tar.gz: 11fe6338525040504c52537e7dfe565bcbb29a07ea8551687a3721deb5d88fb4f3078b7c6c822ff19dd85815eecc434f21828a6dcde1f40bb9aed3737c8a8f8d

data/.gitignore

@@ -3,4 +3,5 @@
 /scratch
 /notebooks
 /examples
-/.vscode
+/.vscode
+/archive

data/README.md

@@ -13,22 +13,38 @@ gem install foxit
 A few quick examples are detailed below:
 
 ### Retrieving Data
-Get an anime item by id. 
+Get an anime item by id or slug. 
 ```ruby
 api = Foxit::API.new()
 result = api.get_anime_by_id(1)
+result = api.get_anime_by_slug('cowboy-bebop')
+```
+The slug is basically the hyphen separated version of the name with the special characters removed. When you click on a anime item in kitsu it will be at the end of the url. This returns the `Anime` object; however, the full json response can be obtained as per below:
+```ruby
+result = api.get_anime_by_id(1, :json)
 ```
 
-This returns the full json response; however, an object based result can be returned as per the following (planned to be returned as default)
+Similarly, getting a users library. Returns a list of `LibraryItem` objects.
 ```ruby
-item = Anime.new(result['data'])
+result = api.get_user_library_by_id(1)
 ```
 
-Similarly, getting a users library. This returns a list of entries from the `'data'` attribute of the json returned. 
+This returns a list of entries (hash format) from the `'data'` attribute of the json returned. 
 ```ruby
 result = api.get_library_by_id(1)
 ```
 
+Examples of getting a batch of anime results:
+```ruby
+result = api.batch_get_anime([1, 4, 8, 25])
+```
+
+Similarly, user library examples below. Note: the library batch results are returned as a flat array (filter on user_id to split out).
+```ruby
+result = api.batch_get_libraries(1..10)
+result = api.batch_get_libraries([1, 2, 3, 5])
+```
+
 
 ### Storing Data with MongoDB
 If you don't have mongodb installed you can download the free community version from [here][mongodb]. Once installed, you need to start the service via terminal:

data/foxit.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.name          = "foxit"
   # spec.version       = Foxit::VERSION
-  spec.version       = "0.1.1"
+  spec.version       = "0.1.3"
   spec.authors       = ["Lachlan Taylor"]
   spec.email         = ["lachlanbtaylor@gmail.com"]
 

data/lib/foxit.rb

@@ -1,5 +1,6 @@
 require "foxit/objects"
 require "foxit/helpers"
+require "foxit/url_builder"
 
 
 module Foxit

data/lib/foxit/api.rb

@@ -1,37 +1,23 @@
 require_relative 'objects'
+require_relative 'helpers'
+require_relative 'url_builder'
 
 require 'net/http'
 require 'json'
-require 'addressable/uri'
 
 
 
 module Foxit
 
-  class API
+  # TODO: probably split out library and anime methods
+  class API < Helpers
 
-    def initialize
-      @root = "https://kitsu.io/api/edge/"
-    end
-  
-  
-    def build_library_url id, type='Anime', status='completed', limit=500
-      uri = Addressable::URI.parse("#{@root}library-entries")
-  
-      uri_query = {
-        "filter[user_id]" => id,
-        "filter[media_type]" => type,
-        "filter[status]" => status,
-        "page[limit]" => limit
-      }
-      uri.query_values = uri_query
-      
-      uri.to_s
-    end
-  
-    
-    def build_media_url entry_id
-      "#{@root}/library-entries/#{entry_id}/relationships/media"
+    attr_reader :urlbuilder
+    attr_accessor :max_threads
+
+    def initialize max_threads=200
+      @max_threads = max_threads
+      @urlbuilder = URLBuilder.new()
     end
   
   
@@ -41,14 +27,14 @@ module Foxit
     end
     
   
-    def get_library_by_url url, entries=[]
+    def _get_library_by_url url, entries=[]
   
       result = self.get_result(url)
       entries += result['data']
     
       if result['links'].key?('next')
         # recursion to retrieve additional results that have ben paginated
-        result = self.get_library_by_url(result['links']['next'], entries)
+        result = self._get_library_by_url(result['links']['next'], entries)
       else
         return entries
       end
@@ -56,8 +42,8 @@ module Foxit
   
   
     def get_library_by_id user_id
-      url = self.build_library_url(user_id)
-      self.get_library_by_url(url)
+      url = @urlbuilder.library(user_id)
+      self._get_library_by_url(url)
     end
   
   
@@ -67,17 +53,16 @@ module Foxit
       @get_media_relationship_by_id ||= {}
       return @get_media_relationship_by_id[entry_id] if @get_media_relationship_by_id.key?(entry_id)
   
-      url = self.build_media_url(entry_id)
+      url = @urlbuilder.media(entry_id)
       self.get_result(url)
     end
   
   
-    def batch_get_results ids, fn, max_threads
+    def batch_get_results ids, fn
       """
       ids: ids of results returned: user_id | library_entry_id in this case.
       fn: function name to use to return results (need to use symbol method name)
           e.g. :get_result
-      max_threads: maximum number of active threads.
       """
   
       results = {}
@@ -85,7 +70,7 @@ module Foxit
   
       ids.each do |id|
   
-        if Thread.list.count % max_threads != 0
+        if Thread.list.count % @max_threads != 0
           thread = Thread.new do
             # adding lock slows down considerably shouldn't matter as results are written to hash?
             results[id] = send(fn, id)
@@ -108,56 +93,101 @@ module Foxit
       results
     end
   
-    # TODO: should probably assign to a @variable
-    def batch_get_libraries user_ids, max_threads=200
+
+    def batch_get_libraries user_ids
   
       all_library_entries = []
-      user_libraries = self.batch_get_results(user_ids, :get_library_by_id, max_threads)
+      user_libraries = self.batch_get_results(user_ids, :get_library_by_id)
     
       user_libraries.each do |user_id, library|
-    
-        media_ids = []
-        library.map { |entry| media_ids << entry['id'] }
-        media_results = self.batch_get_results(media_ids, :get_media_relationship_by_id, max_threads)
-        
-        library.each do |entry|
-          all_library_entries << LibraryItem.new(user_id, entry, media_results[entry['id']])
-        end
-    
+        all_library_entries += self._create_library_items(user_id, library)
       end
     
       all_library_entries
     end
-  
+
+
+    def _create_library_items user_id, library
+
+      # get media_ids from record_ids (not in same response, additional request required)
+      record_ids = []
+      library.map { |entry| record_ids << entry['id'] }
+      media_results = self.batch_get_results(record_ids, :get_media_relationship_by_id)
+      
+      library_entries = []
+      library.each do |entry|
+        library_entries << LibraryItem.new(user_id, entry, media_results[entry['id']])
+      end
+
+      library_entries
+    end
+
     
-    def get_user_library
-      # TODO: return user library using single id call to batch_get_library
+    def get_user_library_by_id user_id
+      library = self.get_library_by_id(user_id)
+      self._create_library_items(user_id, library)
     end
     
   
-    def batch_get_libraries_docs user_ids, max_threads=200
-      all_library_entries = self.batch_get_libraries(user_ids, max_threads)
+    def batch_get_libraries_docs user_ids
+      all_library_entries = self.batch_get_libraries(user_ids)
       
       docs = []
       all_library_entries.map { |entry| docs << entry.to_hash }
   
       docs
     end
-  
-  
-    def build_anime_url id
-      "#{@root}/anime/#{id}"
+
+
+    def _get_anime_by_attr filter_attr, filter_value, rtype=:object
+
+      # TODO: this is a bit of a mess
+
+      case filter_attr
+      when :id
+        url = @urlbuilder.anime_by_id(filter_value)
+      when :slug
+        url = @urlbuilder.anime_by_slug(filter_value)
+      else
+        raise ArgumentError.new("filter_attr argument (1st) not in {:id, :slug}")
+      end
+
+      result = self.get_result(url)
+
+      case rtype
+      when :json
+        return result
+      when :object
+        case filter_attr
+        when :id
+          return Anime.new(result['data'])
+        when :slug
+          # filtering by slug results in the 'data' attribute to be an array
+          return Anime.new(result['data'][0])
+        end
+      else
+        raise ArgumentError.new("rtype not :object or :json")
+      end
     end
-  
-  
-    def get_anime_by_id id
-      url = build_anime_url(id)
-      self.get_result(url)
+
+
+    def get_anime_by_id id, rtype=:object
+      self._get_anime_by_attr(:id, id, rtype)
     end
-  
-  
-    def batch_get_anime anime_ids, max_threads=200
-      results = self.batch_get_results(anime_ids, :get_anime_by_id, max_threads)
+
+
+    def get_anime_by_slug slug, rtype=:object
+      self._get_anime_by_attr(:slug, slug, rtype)
+    end
+
+
+    def _get_anime_by_id_json id
+      self._get_anime_by_attr(:id, id, :json)
+    end
+
+
+    def batch_get_anime anime_ids
+      results = self.batch_get_results(anime_ids, :_get_anime_by_id_json)
   
       anime_items = []
       results.each do |id, result|
@@ -169,8 +199,9 @@ module Foxit
       anime_items
     end
   
-    def get_anime_documents anime_ids, max_threads=200
-      anime_items = self.batch_get_anime(anime_ids, max_threads)
+
+    def get_anime_documents anime_ids
+      anime_items = self.batch_get_anime(anime_ids)
       self.objects_to_hash(anime_items)
     end
   

data/lib/foxit/url_builder.rb

@@ -0,0 +1,43 @@
+require 'addressable/uri'
+
+
+
+class URLBuilder
+
+  attr_reader :root
+
+  def initialize
+    @root = "https://kitsu.io/api/edge/"
+  end
+
+
+  def media entry_id
+    "#{@root}/library-entries/#{entry_id}/relationships/media"
+  end
+
+
+  def library id, type='Anime', status='completed', limit=500
+    uri = Addressable::URI.parse("#{@root}library-entries")
+
+    uri_query = {
+      "filter[user_id]" => id,
+      "filter[media_type]" => type,
+      "filter[status]" => status,
+      "page[limit]" => limit
+    }
+    uri.query_values = uri_query
+    
+    uri.to_s
+  end
+
+  
+  def anime_by_id id
+    "#{@root}/anime/#{id}"
+  end
+
+
+  def anime_by_slug slug
+    "#{@root}/anime?filter[slug]=#{slug}"
+  end
+
+end

data/tests/tc_get_anime_results.rb

@@ -0,0 +1,44 @@
+require "test/unit"
+
+require_relative '../lib/foxit/api'
+
+
+
+class TestGetAnimeResponses < Test::Unit::TestCase
+
+  def setup
+    @api = Foxit::API.new()
+    @slug = 'cowboy-bebop'
+  end
+
+  def test__get_anime_by_attr_id_json
+    result = @api._get_anime_by_attr(:id, 1, :json)
+    assert_equal(@slug, result['data']['attributes']['slug'])
+  end
+
+  def test__get_anime_by_attr_id_object
+    result = @api._get_anime_by_attr(:id, 1, :object)
+    assert_equal(@slug, result.slug)
+  end
+
+  def test__get_anime_by_attr_slug_json
+    result = @api._get_anime_by_attr(:slug, @slug, :json)
+    assert_equal(@slug, result['data'][0]['attributes']['slug'])
+  end
+  
+  def test__get_anime_by_attr_slug_object
+    result = @api._get_anime_by_attr(:slug, @slug, :object)
+    assert_equal(@slug, result.slug)
+  end
+
+  def test_get_anime_by_id_base
+    result = @api.get_anime_by_id(1)
+    assert_equal(@slug, result.slug)
+  end
+
+  def test_get_anime_by_slug_base
+    result = @api.get_anime_by_slug(@slug)
+    assert_equal(@slug, result.slug)
+  end
+
+end

data/tests/tc_get_library_results.rb

@@ -0,0 +1,32 @@
+require "test/unit"
+
+require_relative '../lib/foxit/api'
+
+
+
+class TestGetLibraryResults < Test::Unit::TestCase
+
+  def setup
+    @api = Foxit::API.new()
+    @user_id = 1
+  end
+
+  def test_get_library_by_id
+    result = @api.get_library_by_id(@user_id)
+    assert_kind_of(Hash, result[0], 'result should be an array of Hash objects')
+    assert(result.length > 10, 'user library should not be empty')  # user 1 library is 35 'complete' items
+  end
+
+  def test_get_user_library_by_id
+    result = @api.get_user_library_by_id(@user_id)
+    assert_kind_of(LibraryItem, result[0], 'result should be an array of LibraryItem objects')
+    assert(result.length > 10, 'user library should not be empty')
+  end
+  
+  def test_batch_get_libraries
+    result = @api.batch_get_libraries(1..2)
+    assert_kind_of(LibraryItem, result[0], 'result should be an array of LibraryItem objects')
+    assert(result.length > 40, 'user library should not be empty')
+  end
+
+end

data/tests/ts_all.rb

@@ -0,0 +1,4 @@
+require "test/unit"
+
+require_relative 'tc_get_anime_results'
+require_relative 'tc_get_library_results'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foxit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Lachlan Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -87,6 +87,10 @@ files:
 - lib/foxit/etl.rb
 - lib/foxit/helpers.rb
 - lib/foxit/objects.rb
+- lib/foxit/url_builder.rb
+- tests/tc_get_anime_results.rb
+- tests/tc_get_library_results.rb
+- tests/ts_all.rb
 homepage: https://github.com/rokkuran/foxit
 licenses:
 - MIT