harkness 1.0.0

data/lib/harkness/resources/event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Harkness
+  # The event resource.
+  class EventResource < Resource
+    # Get a list of events.
+    # @param params [Hash] the params to pass to the API request.
+    #   See the [events documentation from Marvel](https://developer.marvel.com/docs#!/public/getCreatorCollection_get_12)
+    #   for valid options.
+    # @return [Harkness::EventDataWrapper] the top level wrapper around the event API response.
+    # @example
+    #   client.events.list
+    #   client.events.list(nameStartsWith: "2016", limit: 10, orderBy: "-name")
+    def list(**params)
+      EventDataWrapper.from_json(get_request("events", params: params).body)
+    end
+
+    # Get a single event.
+    # @param event_id [Integer] the ID of the event.
+    # @return [Harkness::EventDataWrapper] the top level wrapper around the event API response.
+    # @example
+    #   client.events.retrieve(event_id: 1234)
+    def retrieve(event_id:)
+      EventDataWrapper.from_json(get_request("events/#{event_id}").body)
+    end
+
+    # Get a list of comics for a particular event.
+    # @param event_id [Integer] the ID of the event.
+    # @return [Harkness::ComicDataWrapper] the top level wrapper around the comic API response.
+    # @example
+    #   client.events.comics(event_id: 1234)
+    def comics(event_id:)
+      ComicDataWrapper.from_json(get_request("events/#{event_id}/comics").body)
+    end
+
+    # Get a list of series for a particular event.
+    # @param event_id [Integer] the ID of the event.
+    # @return [Harkness::SeriesDataWrapper] the top level wrapper around the series API response.
+    # @example
+    #   client.events.series(event_id: 1234)
+    def series(event_id:)
+      SeriesDataWrapper.from_json(get_request("events/#{event_id}/series").body)
+    end
+
+    # Get a list of stories for a particular event.
+    # @param event_id [Integer] the ID of the event.
+    # @return [Harkness::StoryDataWrapper] the top level wrapper around the story API response.
+    # @example
+    #   client.events.stories(event_id: 1234)
+    def stories(event_id:)
+      StoryDataWrapper.from_json(get_request("events/#{event_id}/stories").body)
+    end
+
+    # Get a list of characters for a particular event.
+    # @param event_id [Integer] the ID of the event.
+    # @return [Harkness::CharaacterDataWrapper] the top level wrapper around the event API response.
+    # @example
+    #   client.events.characters(event_id: 1234)
+    def characters(event_id:)
+      CharacterDataWrapper.from_json(get_request("events/#{event_id}/characters").body)
+    end
+
+    # Get a list of creators for a particular event.
+    # @param event_id [Integer] the ID of the event.
+    # @return [Harkness::CreatorDataWrapper] the top level wrapper around the creator API response.
+    # @example
+    #   client.events.creators(event_id: 1234)
+    def creators(event_id:)
+      CreatorDataWrapper.from_json(get_request("events/#{event_id}/creators").body)
+    end
+  end
+end

data/lib/harkness/resources/series.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Harkness
+  # The series resource.
+  class SeriesResource < Resource
+    # Get a list of series.
+    # @param params [Hash] the params to pass to the API request.
+    #   See the [series documentation from Marvel](https://developer.marvel.com/docs#!/public/getCreatorCollection_get_12)
+    #   for valid options.
+    # @return [Harkness::SeriesDataWrapper] the top level wrapper around the series API response.
+    # @example
+    #   client.series.list
+    #   client.series.list(titleStartsWith: "Ant-", limit: 10, orderBy: "title")
+    def list(**params)
+      SeriesDataWrapper.from_json(get_request("series", params: params).body)
+    end
+
+    # Get a single series.
+    # @param series_id [Integer] the ID of the series.
+    # @return [Harkness::SeriesDataWrapper] the top level wrapper around the series API response.
+    # @example
+    #   client.series.retrieve(series_id: 1234)
+    def retrieve(series_id:)
+      SeriesDataWrapper.from_json(get_request("series/#{series_id}").body)
+    end
+
+    # Get a list of comics for a particular series.
+    # @param series_id [Integer] the ID of the series.
+    # @return [Harkness::ComicDataWrapper] the top level wrapper around the comic API response.
+    # @example
+    #   client.series.comics(series_id: 1234)
+    def comics(series_id:)
+      ComicDataWrapper.from_json(get_request("series/#{series_id}/comics").body)
+    end
+
+    # Get a list of stories for a particular series.
+    # @param series_id [Integer] the ID of the series.
+    # @return [Harkness::StoryDataWrapper] the top level wrapper around the story API response.
+    # @example
+    #   client.series.stories(series_id: 1234)
+    def stories(series_id:)
+      StoryDataWrapper.from_json(get_request("series/#{series_id}/stories").body)
+    end
+
+    # Get a list of characters for a particular series.
+    # @param series_id [Integer] the ID of the series.
+    # @return [Harkness::CharacterDataWrapper] the top level wrapper around the character API response.
+    # @example
+    #   client.series.characters(series_id: 1234)
+    def characters(series_id:)
+      CharacterDataWrapper.from_json(get_request("series/#{series_id}/characters").body)
+    end
+
+    # Get a list of creators for a particular series.
+    # @param series_id [Integer] the ID of the series.
+    # @return [Harkness::CreatorDataWrapper] the top level wrapper around the creator API response.
+    # @example
+    #   client.series.creators(series_id: 1234)
+    def creators(series_id:)
+      CreatorDataWrapper.from_json(get_request("series/#{series_id}/creators").body)
+    end
+
+    # Get a list of events for a particular series.
+    # @param series_id [Integer] the ID of the series.
+    # @return [Harkness::EventDataWrapper] the top level wrapper around the event API response.
+    # @example
+    #   client.series.events(series_id: 1234)
+    def events(series_id:)
+      EventDataWrapper.from_json(get_request("series/#{series_id}/events").body)
+    end
+  end
+end

data/lib/harkness/resources/story.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Harkness
+  # The story resource.
+  class StoryResource < Resource
+    # Get a list of stories.
+    # @param params [Hash] the params to pass to the API request.
+    #   See the [stories documentation from Marvel](https://developer.marvel.com/docs#!/public/getCreatorCollection_get_12)
+    #   for valid options.
+    # @return [Harkness::StoryDataWrapper] the top level wrapper around the story API response.
+    # @example
+    #   client.stories.list
+    #   client.stories.list(creators: "1234", limit: 10, orderBy: "id")
+    def list(**params)
+      StoryDataWrapper.from_json(get_request("stories", params: params).body)
+    end
+
+    # Get a single story.
+    # @param story_id [Integer] the ID of the story.
+    # @return [Harkness::StoryDataWrapper] the top level wrapper around the story API response.
+    # @example
+    #   client.stories.retrieve(story_id: 1234)
+    def retrieve(story_id:)
+      StoryDataWrapper.from_json(get_request("stories/#{story_id}").body)
+    end
+
+    # Get a list of comics for a particular story.
+    # @param story_id [Integer] the ID of the story.
+    # @return [Harkness::ComicDataWrapper] the top level wrapper around the comic API response.
+    # @example
+    #   client.stories.comics(story_id: 1234)
+    def comics(story_id:)
+      ComicDataWrapper.from_json(get_request("stories/#{story_id}/comics").body)
+    end
+
+    # Get a list of events for a particular story.
+    # @param story_id [Integer] the ID of the story.
+    # @return [Harkness::EventDataWrapper] the top level wrapper around the event API response.
+    # @example
+    #   client.stories.events(story_id: 1234)
+    def events(story_id:)
+      EventDataWrapper.from_json(get_request("stories/#{story_id}/events").body)
+    end
+
+    # Get a list of series for a particular story.
+    # @param story_id [Integer] the ID of the story.
+    # @return [Harkness::SeriesDataWrapper] the top level wrapper around the series API response.
+    # @example
+    #   client.stories.series(story_id: 1234)
+    def series(story_id:)
+      SeriesDataWrapper.from_json(get_request("stories/#{story_id}/series").body)
+    end
+
+    # Get a list of characters for a particular story.
+    # @param story_id [Integer] the ID of the story.
+    # @return [Harkness::CharacterDataWrapper] the top level wrapper around the character API response.
+    # @example
+    #   client.stories.characters(story_id: 1234)
+    def characters(story_id:)
+      CharacterDataWrapper.from_json(get_request("stories/#{story_id}/characters").body)
+    end
+
+    # Get a list of creators for a particular story.
+    # @param story_id [Integer] the ID of the story.
+    # @return [Harkness::CreatorDataWrapper] the top level wrapper around the creator API response.
+    # @example
+    #   client.stories.creators(story_id: 1234)
+    def creators(story_id:)
+      CreatorDataWrapper.from_json(get_request("stories/#{story_id}/creators").body)
+    end
+  end
+end

data/lib/harkness/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Harkness
+  VERSION = "1.0.0"
+end

data/lib/harkness.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "shale"
+
+# Harkness
+require "harkness/version"
+require "harkness/client"
+require "harkness/resource"
+require "harkness/error"
+
+# Base objects
+require "harkness/models/base/data_container"
+require "harkness/models/base/data_wrapper"
+require "harkness/models/base/summary"
+
+# Shared models
+require "harkness/models/text_object"
+require "harkness/models/image"
+require "harkness/models/url"
+require "harkness/models/comic_list"
+require "harkness/models/creator_list"
+require "harkness/models/character_list"
+require "harkness/models/event_list"
+require "harkness/models/story_list"
+require "harkness/models/series_list"
+
+# Models
+require "harkness/models/character"
+require "harkness/models/comic"
+require "harkness/models/creator"
+require "harkness/models/event"
+require "harkness/models/series"
+require "harkness/models/story"
+
+# Resources
+require "harkness/resources/character"
+require "harkness/resources/comic"
+require "harkness/resources/creator"
+require "harkness/resources/event"
+require "harkness/resources/series"
+require "harkness/resources/story"

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification
+name: harkness
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- duffn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: shale
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+description: Dive into the Marvel universe with this comprehensive Ruby library for
+  the Marvel API at https://developer.marvel.com.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.MD
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- harkness.gemspec
+- lib/harkness.rb
+- lib/harkness/client.rb
+- lib/harkness/error.rb
+- lib/harkness/models/base/data_container.rb
+- lib/harkness/models/base/data_wrapper.rb
+- lib/harkness/models/base/summary.rb
+- lib/harkness/models/character.rb
+- lib/harkness/models/character_list.rb
+- lib/harkness/models/comic.rb
+- lib/harkness/models/comic_list.rb
+- lib/harkness/models/creator.rb
+- lib/harkness/models/creator_list.rb
+- lib/harkness/models/event.rb
+- lib/harkness/models/event_list.rb
+- lib/harkness/models/image.rb
+- lib/harkness/models/series.rb
+- lib/harkness/models/series_list.rb
+- lib/harkness/models/story.rb
+- lib/harkness/models/story_list.rb
+- lib/harkness/models/text_object.rb
+- lib/harkness/models/url.rb
+- lib/harkness/resource.rb
+- lib/harkness/resources/character.rb
+- lib/harkness/resources/comic.rb
+- lib/harkness/resources/creator.rb
+- lib/harkness/resources/event.rb
+- lib/harkness/resources/series.rb
+- lib/harkness/resources/story.rb
+- lib/harkness/version.rb
+homepage: https://github.com/duffn/harkness
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/duffn/harkness
+  source_code_uri: https://github.com/duffn/harkness
+  changelog_uri: https://github.com/duffn/harkness/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A library for working (playing) with the Marvel API.
+test_files: []