comicvine 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e57f06754f14d9c6e34e4c7bb96c9dfd7f3b5a05
-  data.tar.gz: 3b7e8ee97f5e4201482545f1e55746376a24c3c0
+  metadata.gz: 3b853ef9a066f23008e9a9c8dce147714133d01c
+  data.tar.gz: 2dd9897234f1313c78e29439697627f8dc08dbe6
 SHA512:
-  metadata.gz: 7ae0274f1a68527ba65c43344de16bb918d392041ea19ef79f678bd24251d9445cddf6408b974959a148fa80bfdc29607ed48738285ea6fde82261c2b178abd8
-  data.tar.gz: 28ba70a48ca692f6d17ad15aeade62684a98f3f713bc1dcf40fc0416d5f8e24e81c5417b59edb6bb19a8e34075e20839e9958e5a3e88a6ec63921909d5269d4a
+  metadata.gz: 1e01d4e5a1c09b824ff07dfecf91af1b891713a96247b2bac236a261886885f6ad0c8a376fed54476cc98365b9874cd86f69b243899a82e0e5c61e15cfeeec88
+  data.tar.gz: c30f5d767bb36b32956858e5eba92dcc34d9cc8ed3e571da4cbd6e128ea4f896f01c5f2951e7be0ea98d385eea48a3877607ae28b4ee23923bd0af026b51f83a

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
 end
 
 YARD::Rake::YardocTask.new do |t|
@@ -21,7 +22,7 @@ task :default => :test
 task :gen_checksum do
   require 'digest/sha2'
   built_gem_path = 'pkg/comicvine-'+ComicVine::VERSION+'.gem'
-  checksum = Digest::SHA512.new.hexdigest(File.read(built_gem_path))
-  checksum_path = 'checksum/comicvine-'+ComicVine::VERSION+'.gem.sha512'
+  checksum = Digest::SHA256.new.hexdigest(File.read(built_gem_path))
+  checksum_path = 'checksum/comicvine-'+ComicVine::VERSION+'.gem.sha256'
   File.open(checksum_path, 'w' ) {|f| f.write(checksum) }
 end

data/checksum/comicvine-0.1.0.gem.sha256

@@ -0,0 +1 @@
+92388ee99e2c725b1375a106605187fd29bb3ebe12c1beb591cf06d7e9949e18

data/checksum/comicvine-0.1.1.gem.sha256

@@ -0,0 +1 @@
+21c5dd6f5935c7f44468fcba50e4297a66add76177f4ca9e8a48cd5edb801f89

data/comicvine.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2'
 
   spec.cert_chain  = ['certs/homans.pem']
   spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/

data/lib/comicvine.rb

@@ -59,6 +59,9 @@ module ComicVine
     # ComicVine API Key. Set to the environmental variable CV_API_KEY by default if present
     @@api_key = ENV['CV_API_KEY'] || nil
 
+    # Api response timeout in seconds
+    @@api_timeout = 10
+
     class << self
 
       ##
@@ -85,6 +88,22 @@ module ComicVine
         @@api_key = key
       end
 
+      ##
+      # Returns ComicVine API request timeout value
+      # @return [Integer]
+      # @since 0.1.2
+      def api_timeout
+        @@api_timeout
+      end
+
+      ##
+      # Sets the ComicVine API request timeout value in seconds
+      # @param seconds [Integer]
+      # @since 0.1.0
+      def api_timeout=(seconds)
+        @@api_timeout = seconds.to_i
+      end
+
       ##
       # Makes request for the current api version
       #
@@ -178,18 +197,18 @@ module ComicVine
         }
         ops_hash.merge! params
         resp = _make_request(resource, ops_hash)
-        ComicVine::Resource.new(resp['results'])
+        ComicVine::Resource.create_resource(resp['results'])
       end
 
       ##
       # Will fetch the provided +url+ as a {ComicVine::Resource}
       # @example
-      #   ComicVine::API.get_details_by_url('http://comicvine.gamespot.com/api/issue/4000-371103')
+      #   ComicVine::API.get_details_by_url('http://comicvine.gamespot.com/api/issue/4000-371103') #=> ComicVine::Resource::Issue
       # @param url [String]
       # @return [ComicVine::Resource]
       def get_details_by_url(url)
         resp = _make_url_request(url)
-        ComicVine::Resource.new(resp['results'])
+        ComicVine::Resource::create_resource(resp['results'])
       end
 
       ##
@@ -199,8 +218,7 @@ module ComicVine
           get_list method_sym, arguments.first
         elsif find_detail(method_sym)
           get_details method_sym, *arguments
-        elsif
-        super
+        elsif super
         end
       end
 
@@ -269,11 +287,13 @@ module ComicVine
         options[:params].merge! params
 
         begin
+          # Sleep for 1 sec to avoid rate limit
+          sleep 1
           # Perform request
           request = RestClient::Request.execute(
               method: :get,
               url: url,
-              timeout: 10,
+              timeout: self.api_timeout,
               headers: options
           )
             #request = RestClient.get(url, options)

data/lib/comicvine/list.rb

@@ -53,7 +53,7 @@ module ComicVine
       super(resp)
 
       @resource = resc
-      @cvos = resp['results'].map { |r| ComicVine::Resource.new(r) }
+      @cvos = resp['results'].map { |r| ComicVine::Resource.create_resource(r) }
     end
 
     def next_page
@@ -79,7 +79,7 @@ module ComicVine
 
       @resource = resc
       @query = query
-      @cvos = resp['results'].map { |r| ComicVine::Resource.new(r) }
+      @cvos = resp['results'].map { |r| ComicVine::Resource.create_resource(r) }
     end
 
     ##

data/lib/comicvine/resource.rb

@@ -12,21 +12,54 @@ module ComicVine
         self.class.class_eval { attr_reader k } unless self.respond_to? k
 
         # Convert sub arrays to objects
-        v.collect! { |i| Resource.new i } if v.kind_of?(Array) && !v.empty? && v.first.key?('api_detail_url')
+        v.collect! { |i| ComicVine::Resource::create_resource(i) } if v.kind_of?(Array) && !v.empty? && v.first.key?('api_detail_url')
 
         # Convert sub hashes to objects
-        v = Resource.new v if v.kind_of?(Hash) && v.key?('api_detail_url')
+        if v.kind_of?(Hash) && v.key?('api_detail_url')
+          v = ComicVine::Resource::create_resource(v)
+        end
 
         # Set the instance variable to value
         instance_variable_set "@#{k}", v
       end
     end
 
+    ##
+    # Fetches data from ComicVine based on objects api_detail_url
+    #
     # @return [ComicVine::Resource]
+    # @since 0.1.0
     def fetch
       ComicVine::API.get_details_by_url(self.api_detail_url)
     end
 
+    ##
+    # Fetches data from ComicVine based on objects api_detail_url and updates self with new values
+    #
+    # @return [ComicVine::Resource]
+    # @since 0.1.2
+    def fetch!
+      obj = ComicVine::API.get_details_by_url(self.api_detail_url)
+      self.methods.each do |m|
+        # Look for methods that can be set (i.e. ends with a =)
+        if m.to_s =~ /^(?!_)([\w\d\_]+)=$/
+          # Save our method symbols in a more readable fashion
+          get_m = $1.to_sym
+          set_m = m
+
+          # Skip setting ids, as this should be handled by the classes when setting the children objects if needed
+          next if get_m.to_s =~ /\_ids?$/ || set_m.to_s =~ /attributes/
+
+          # Verify the new object has a get method and it is not nil or empty
+          if self.respond_to?(set_m) && obj.respond_to?(get_m) && !obj.method(get_m).call.nil?
+            # Now set the method to the new value
+            self.method(set_m).call obj.method(get_m).call
+          end
+        end
+      end
+      self
+    end
+
     # @private
     def method_missing(method_sym, *arguments, &block)
       if method_sym.to_s =~ /^get_(.*)$/
@@ -49,5 +82,75 @@ module ComicVine
       elsif super
       end
     end
+
+    ##
+    # Identifies objects resource type based on its ComicVine api_detail_url
+    #
+    # @return [Symbol]
+    # @since 0.1.2
+    def resource_type
+      ComicVine::Resource(self.api_detail_url)
+    end
+
+    class << self
+
+      ##
+      # Takes hash and returns a {ComicVine::Resource}
+      #
+      # @param attr [Hash]
+      # @return [ComicVine::Resource]
+      # @since 0.1.2
+      def create_resource(attr)
+        ComicVine::Resource.new attr
+      end
+
+      ##
+      # Parses supplied api_detail_url and returns the translated type symbol
+      #
+      # @param response [Hash]
+      # @return [Symbol]
+      # @since 0.1.2
+      def identify_and_update_response(response)
+        type = ComicVine::Resource::identify_type(response['api_detail_url'])
+
+        case type
+          when :first_appeared_in_issue
+            type = :issue
+            response['api_detail_url'].to_s.sub! 'first_appeared_in_issue', 'issue'
+          when :thing
+            type = :object
+            response['api_detail_url'].to_s.sub! 'thing', 'object'
+          when :creator
+            type = :person
+            response['api_detail_url'].to_s.sub! 'creator', 'person'
+          when :writer
+            type = :person
+            response['api_detail_url'].to_s.sub! 'writer', 'person'
+          when :studio
+            type = :publisher
+            response['api_detail_url'].to_s.sub! 'studio', 'publisher'
+          when :arc
+            type = :story_arc
+            response['api_detail_url'].to_s.sub! 'arc', 'story_arc'
+          else
+        end
+
+        type
+      end
+
+      ##
+      # Parses supplied api_detail_url and returns the translated type symbol
+      #
+      # @param api_detail_url [String]
+      # @return [Symbol]
+      # @since 0.1.2
+      def identify_type(api_detail_url)
+        if api_detail_url.to_s =~ /comicvine\.gamespot\.com\/api\/(\w+)\/?/
+          $1.to_s.to_sym
+        else
+          nil
+        end
+      end
+    end
   end
 end

data/lib/comicvine/{modules.rb → resource/resources.rb}

@@ -1,13 +1,28 @@
 module ComicVine
-  ##
-  # Holds the various modules for ComicVine resource attributes
-  # @since 0.1.0
-  module ResourceAttributes
-
-    ##
-    # Module to hold character resource attributes
-    # @since 0.1.0
-    module Character
+  class Resource
+
+    ##
+    # Takes hash and returns a subclass of {ComicVine::Resource} based on identified type
+    #
+    # @example
+    #   ComicVine::Resource.create_resource(hash) #=> #<ComicVine::Resource::Issue:0x007fa6a427bbe8>
+    #
+    # @param attr [Hash]
+    # @return [ComicVine::Resource]
+    # @since 0.1.2
+    def self.create_resource(attr)
+      type = ComicVine::Resource::identify_and_update_response(attr)
+      if type
+        Object.class_eval('ComicVine::Resource::' + type.to_s.capitalize).new attr
+      else
+        raise ScriptError, 'Unknown type for api_detail_url: ' + attr['api_detail_url']
+      end
+    end
+
+    ##
+    # Extends {ComicVine::Resource} to add character resource attributes
+    # # @since 0.1.2
+    class Character < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :birth, :character_enemies, :character_friends,
                     :count_of_issue_appearances, :creators, :date_added, :date_last_updated, :deck, :description,
                     :first_appeared_in_issue, :gender, :id, :image, :issue_credits, :issues_died_in, :movies, :name,
@@ -16,25 +31,25 @@ module ComicVine
     end
 
     ##
-    # Module to hold chat resource attributes
-    # @since 0.1.0
-    module Chat
+    # Extends {ComicVine::Resource} to add chat resource attributes
+    # @since 0.1.2
+    class Chat < ComicVine::Resource
       attr_accessor :api_detail_url, :channel_name, :deck, :image, :password, :site_detail_url, :title
     end
 
     ##
-    # Module to hold concept resource attributes
-    # @since 0.1.0
-    module Concept
+    # Extends {ComicVine::Resource} to add concept resource attributes
+    # @since 0.1.2
+    class Concept < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :count_of_issue_appearances, :date_added, :date_last_updated, :deck,
                     :description, :first_appeared_in_issue, :id, :image, :issue_credits, :movies, :name,
                     :site_detail_url, :start_year, :volume_credits
     end
 
     ##
-    # Module to hold episode resource attributes
-    # @since 0.1.0
-    module Episode
+    # Extends {ComicVine::Resource} to add episode resource attributes
+    # @since 0.1.2
+    class Episode < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :character_credits, :characters_died_in, :concept_credits, :air_date,
                     :date_added, :date_last_updated, :deck, :description, :first_appearance_characters,
                     :first_appearance_concepts, :first_appearance_locations, :first_appearance_objects,
@@ -44,30 +59,30 @@ module ComicVine
     end
 
     ##
-    # Module to hold issue resource attributes
-    # @since 0.1.0
-    module Issue
-      attr_accessor :aliases, :api_detail_url, :character_credits, :characters_died_in, :concept_credits, :cover_date,
+    # Extends {ComicVine::Resource} to add issue resource attributes
+    # @since 0.1.2
+    class Issue < ComicVine::Resource
+      attr_accessor :aliases, :api_detail_url, :character_credits, :character_died_in, :concept_credits, :cover_date,
                     :date_added, :date_last_updated, :deck, :description, :disbanded_teams,
                     :first_appearance_characters, :first_appearance_concepts, :first_appearance_locations,
                     :first_appearance_objects, :first_appearance_storyarcs, :first_appearance_teams, :has_staff_review,
                     :id, :image, :issue_number, :location_credits, :name, :object_credits, :person_credits,
-                    :site_detail_url, :store_date, :story_arc_credits, :team_credits, :teams_disbanded_in, :volume
+                    :site_detail_url, :store_date, :story_arc_credits, :team_credits, :team_disbanded_in, :volume
     end
 
     ##
-    # Module to hold location resource attributes
-    # @since 0.1.0
-    module Location
+    # Extends {ComicVine::Resource} to add location resource attributes
+    # @since 0.1.2
+    class Location < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :count_of_issue_appearances, :date_added, :date_last_updated, :deck,
                     :description, :first_appeared_in_issue, :id, :image, :issue_credits, :movies, :name,
                     :site_detail_url, :start_year, :story_arc_credits, :volume_credits
     end
 
     ##
-    # Module to hold movie resource attributes
-    # @since 0.1.0
-    module Movie
+    # Extends {ComicVine::Resource} to add movie resource attributes
+    # @since 0.1.2
+    class Movie < ComicVine::Resource
       attr_accessor :api_detail_url, :box_office_revenue, :budget, :characters, :concepts, :date_added,
                     :date_last_updated, :deck, :description, :distributor, :has_staff_review, :id, :image, :locations,
                     :name, :producers, :rating, :release_date, :runtime, :site_detail_url, :studios, :teams, :things,
@@ -75,75 +90,76 @@ module ComicVine
     end
 
     ##
-    # Module to hold object resource attributes
-    # @since 0.1.0
-    module Object
+    # Extends {ComicVine::Resource} to add object resource attributes
+    # @since 0.1.2
+    class Object < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :count_of_issue_appearances, :date_added, :date_last_updated, :deck,
                     :description, :first_appeared_in_issue, :id, :image, :issue_credits, :movies, :name,
                     :site_detail_url, :start_year, :story_arc_credits, :volume_credits
     end
 
     ##
-    # Module to hold origin resource attributes
-    # @since 0.1.0
-    module Origin
-      attr_accessor :api_detail_url, :character_set, :id, :name, :profiles, :site_detail_url
+    # Extends {ComicVine::Resource} to add origin resource attributes
+    # @since 0.1.2
+    class Origin < ComicVine::Resource
+      attr_accessor :api_detail_url, :character_set, :characters, :id, :name, :profiles, :site_detail_url
     end
 
     ##
-    # Module to hold person resource attributes
-    # @since 0.1.0
-    module Person
+    # Extends {ComicVine::Resource} to add person resource attributes
+    # @since 0.1.2
+    class Person < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :birth, :count_of_issue_appearances, :country, :created_characters,
                     :date_added, :date_last_updated, :death, :deck, :description, :email, :gender, :hometown, :id,
                     :image, :issue_credits, :name, :site_detail_url, :story_arc_credits, :volume_credits, :website
     end
 
     ##
-    # Module to hold power resource attributes
-    # @since 0.1.0
-    module Power
-      attr_accessor :attr_accessor, :aliases, :api_detail_url, :characters, :date_added, :date_last_updated,
+    # Extends {ComicVine::Resource} to add power resource attributes
+    # @since 0.1.2
+    class Power < ComicVine::Resource
+      attr_accessor :aliases, :api_detail_url, :characters, :date_added, :date_last_updated,
                     :description, :id, :name, :site_detail_url
     end
 
     ##
-    # Module to hold promo resource attributes
-    # @since 0.1.0
-    module Promo
+    # Extends {ComicVine::Resource} to add promo resource attributes
+    # @since 0.1.2
+    class Promo < ComicVine::Resource
       attr_accessor :api_detail_url, :date_added, :deck, :id, :image, :link, :name, :resource_type, :user
     end
 
     ##
-    # Module to hold publisher resource attributes
-    # @since 0.1.0
-    module Publisher
+    # Extends {ComicVine::Resource} to add publisher resource attributes
+    # @since 0.1.2
+    class Publisher < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :characters, :date_added, :date_last_updated, :deck, :description, :id,
                     :image, :location_address, :location_city, :location_state, :name, :site_detail_url, :story_arcs,
                     :teams, :volumes
     end
+
     ##
-    # Module to hold series resource attributes
-    # @since 0.1.0
-    module Series
+    # Extends {ComicVine::Resource} to add series resource attributes
+    # @since 0.1.2
+    class Series < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :character_credits, :count_of_episodes, :date_added, :date_last_updated,
                     :deck, :description, :first_episode, :id, :image, :last_episode, :location_credits, :name,
                     :publisher, :site_detail_url, :start_year
     end
 
     ##
-    # Module to hold story_arc resource attributes
-    # @since 0.1.0
-    module StoryArc
+    # Extends {ComicVine::Resource} to add story_arc resource attributes
+    # @since 0.1.2
+    class StoryArc < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :count_of_issue_appearances, :date_added, :date_last_updated, :deck,
                     :description, :first_appeared_in_issue, :id, :image, :issues, :movies, :name, :publisher,
                     :site_detail_url
     end
 
     ##
-    # Module to hold team resource attributes
-    # @since 0.1.0
-    module Team
+    # Extends {ComicVine::Resource} to add team resource attributes
+    # @since 0.1.2
+    class Team < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :character_enemies, :character_friends, :characters,
                     :count_of_issue_appearances, :count_of_team_members, :date_added, :date_last_updated, :deck,
                     :description, :disbanded_in_issues, :first_appeared_in_issue, :id, :image, :issue_credits,
@@ -152,43 +168,57 @@ module ComicVine
     end
 
     ##
-    # Module to hold type resource attributes
-    # @since 0.1.0
-    module Type
+    # Extends {ComicVine::Resource} to add type resource attributes
+    # @since 0.1.2
+    class Type < ComicVine::Resource
       attr_accessor :detail_resource_name, :list_resource_name, :id
     end
 
     ##
-    # Module to hold video resource attributes
-    # @since 0.1.0
-    module Video
+    # Extends {ComicVine::Resource} to add video resource attributes
+    # @since 0.1.2
+    class Video < ComicVine::Resource
       attr_accessor :api_detail_url, :deck, :hd_url, :high_url, :id, :image, :length_seconds, :low_url, :name,
                     :publish_date, :site_detail_url, :url, :user
     end
 
     ##
-    # Module to hold video_category resource attributes
-    # @since 0.1.0
-    module VideoCategory
+    # Extends {ComicVine::Resource} to add video_category resource attributes
+    # @since 0.1.2
+    class VideoCategory < ComicVine::Resource
       attr_accessor :api_detail_url, :deck, :id, :name, :site_detail_url
     end
 
     ##
-    # Module to hold video_type resource attributes
-    # @since 0.1.0
-    module VideoType
+    # Extends {ComicVine::Resource} to add video_type resource attributes
+    # @since 0.1.2
+    class VideoType < ComicVine::Resource
       attr_accessor :api_detail_url, :deck, :id, :name, :site_detail_url
     end
 
     ##
-    # Module to hold volume resource attributes
-    # @since 0.1.0
-    module Volume
+    # Extends {ComicVine::Resource} to add volume resource attributes
+    # @since 0.1.2
+    class Volume < ComicVine::Resource
       attr_accessor :aliases, :api_detail_url, :character_credits, :concept_credits, :count_of_issues, :date_added,
                     :date_last_updated, :deck, :description, :first_issue, :id, :image, :last_issue, :location_credits,
                     :name, :object_credits, :person_credits, :publisher, :site_detail_url, :start_year, :team_credits
     end
 
+    ##
+    # Extends {ComicVine::Resource} to add review resource attributes
+    # @since 0.1.2
+    class Review < ComicVine::Resource
+      attr_accessor :api_detail_url, :id, :name, :site_detail_url
+
+      # @private
+      # @since 0.1.2
+      def fetch
+        self
+      end
+
+    end
+
   end
 end
 

data/lib/comicvine/version.rb

@@ -1,4 +1,4 @@
 module ComicVine
   # Current gem version number
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comicvine
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Holden Omans
@@ -30,7 +30,7 @@ cert_chain:
   VpDNqh/BlGMQ0mqAEuBFZFSNaroph6JLUz1ykVvQENOQLThxAjolK7SAUrdoBDOc
   fXEVP1s+hpJB6IEU8/LW016TU8WpnA+MHGfJRtkrUm/cEsWU
   -----END CERTIFICATE-----
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,12 +171,13 @@ files:
 - bin/console
 - bin/setup
 - certs/homans.pem
-- checksum/comicvine-0.1.0.gem.sha512
+- checksum/comicvine-0.1.0.gem.sha256
+- checksum/comicvine-0.1.1.gem.sha256
 - comicvine.gemspec
 - lib/comicvine.rb
 - lib/comicvine/list.rb
-- lib/comicvine/modules.rb
 - lib/comicvine/resource.rb
+- lib/comicvine/resource/resources.rb
 - lib/comicvine/version.rb
 homepage: https://github.com/kalinon/ruby-comicvine-api
 licenses:
@@ -190,7 +191,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/checksum/comicvine-0.1.0.gem.sha512

@@ -1 +0,0 @@
-98a260c7e46e2166f400b41fc88d9da43d2f75c42712fd1f137734d20f8cebdeb101b735edb005f94cf67878d7f44c7da686775229edbc2751d0468581feed7c