harkness 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bde0dd383b950752ad75505b15a0b9f4a3d0a8fd63339136ec03a625f0c371c8
+  data.tar.gz: 1e158b73d045f626ca673be4b5e6588ce018d5a9384c97d74a223d52c628e7a9
+SHA512:
+  metadata.gz: 3eaf2fc1c274671c6970e7f6ed4b26c1fc4e4dcebb73a83b074243f8a180ea04ef69215aa0cef79270b50f36d9bf2d6dfbe7f352d2976d5e6d0d485091f316ba
+  data.tar.gz: 6ccf1aca3a8baf4d90505a25fe99debbb6636f987b99de187f717c4d033960127c8fd402ac8b82bd5f25a4f4e53160bc1965958ace2868c62a71862ad6233ebc

data/.rubocop.yml

@@ -0,0 +1,94 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: disable
+
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 1500
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/PreferredHashMethods:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    reduce: "inject"
+
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Lint/SuppressedException:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [1.0.0] (2023-03-12)
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 3457341+duffn@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.MD

@@ -0,0 +1,91 @@
+# Contributing
+
+## Fork the Project
+
+Fork the [project on GitHub](https://github.com/duffn/harkness) and check out your copy.
+
+```
+git clone https://github.com/contributor/harkness.git
+cd harkness
+git remote add upstream https://github.com/duffn/harkness.git
+```
+
+## Create a topic branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout main
+git pull upstream main
+git checkout -b my-feature-branch
+```
+
+## Run the project locally
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Write tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build and add them to the [spec](spec) directory.
+
+I appreciate pull requests that highlight or reproduce a problem, even without a fix!
+
+## Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/rubocop/rubocop). Run `bundle exec rake rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake spec` completes without errors.
+
+## Commit Changes
+
+This repository uses [`release-please`](https://github.com/googleapis/release-please) for changelog and release generation. Your commits to your PRs should follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+Writing good commit messages is important. A commit message should describe what changed and why and follow the above conventional commits format.
+
+```
+git add .
+git commit -m "feat: my awesome and useful commit message"
+```
+
+## Push
+
+```
+git push origin my-feature-branch
+```
+
+## Make a Pull Request
+
+Go to https://github.com/contributor/harkness.git and select your feature branch. Click the `Pull Request` button and fill out the form. Pull requests are usually reviewed within a few days.
+
+## Rebase
+
+If you've been working on a change for a while, rebase with `upstream/main`.
+
+```
+git fetch upstream
+git rebase upstream/main
+git push origin my-feature-branch -f
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+## Check on Your Pull Request
+
+Go back to your pull request after a minute or two and see whether it passed GitHub Actions CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+## Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainer will ask you to do more, or fix seemingly benign problems. Hang in there!
+
+## Thank You
+
+Please do know that I really appreciate and value your time and work.

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 duffn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,155 @@
+# Harkness
+
+A full-featured and painstakingly documented library for working (playing) with the [Marvel API](https://developer.marvel.com/docs).
+
+![main](https://github.com/duffn/harkness/actions/workflows/test.yml/badge.svg) [![codecov](https://codecov.io/gh/duffn/harkness/branch/main/graph/badge.svg?token=9XUA33QIM2)](https://codecov.io/gh/duffn/harkness)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```
+bundle add harkness
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```
+gem install harkness
+```
+
+## Usage
+
+- Get your Marvel API public key and private key on your [Marvel developer account](https://developer.marvel.com/account).
+
+- Set your public key and private key as environment variables using your preferred method.
+
+```bash
+export MARVEL_PUBLIC_KEY=my_public_key
+export MARVEL_PRIVATE_KEY=my_private_key
+```
+
+- Create a Harkness client.
+
+```ruby
+require "harkness"
+
+client = Harkness::Client.new(public_key: ENV["MARVEL_PUBLIC_KEY"], private_key: ENV["MARVEL_PRIVATE_KEY"])
+```
+
+- Use the client to access API resources.
+
+  - Use `list` on any resource to get all, paginated, items for that resource.
+
+    - Pass any [valid parameters](https://developer.marvel.com/docs) to the `list` method.
+
+    ```ruby
+    client.characters.list(nameStartsWith: "Ant-", limit: 10, orderBy: "-modified")
+    ```
+
+  - Use `retrieve` to get a single resource by ID.
+  - Get related resources, too!
+    - Ex. `client.comics.characters(comic_id: 1234)` will get all characters for the comic with ID `1234`.
+
+- All resources are classes in the `Harkness` module and attributes can be easily accessed just as you would access them normally.
+
+```
+irb(main):001:0> client = Harkness::Client.new(public_key: ENV["MARVEL_PUBLIC_KEY"], private_key: ENV["MARVEL_PRIVATE_KEY"])
+=>
+#<Harkness::Client:0x00000001083a93d8
+...
+irb(main):002:0> character = client.characters.list(nameStartsWith: "Ant-", limit: 1, orderBy: "modified")
+=>
+#<Harkness::CharacterDataWrapper:0x0000000108c740f8
+...
+irb(main):003:0> character.data.results[0].name
+=> "Ant-Man (Eric O'Grady)"
+```
+
+### Resources
+
+#### Characters
+
+```ruby
+client.characters.list
+client.characters.retrieve(character_id: 1234)
+client.characters.comics(character_id: 1234)
+client.characters.events(character_id: 1234)
+client.characters.series(character_id: 1234)
+client.characters.stories(character_id: 1234)
+```
+
+#### Comics
+
+```ruby
+client.comics.list
+client.comics.retrieve(comic_id: 1234)
+client.comics.characters(comic_id: 1234)
+client.comics.creators(comic_id: 1234)
+client.comics.events(comic_id: 1234)
+client.comics.stories(comic_id: 1234)
+```
+
+#### Creators
+
+```ruby
+client.creators.list
+client.creators.retrieve(comic_id: 1234)
+client.creators.comics(creator_id: 1234)
+client.creators.events(creator_id: 1234)
+client.creators.series(creator_id: 1234)
+client.creators.stories(creator_id: 1234)
+```
+
+#### Events
+
+```ruby
+client.events.list
+client.events.retrieve(event_id: 1234)
+client.events.comics(event_id: 1234)
+client.events.series(event_id: 1234)
+client.events.creators(event_id: 1234)
+client.events.characters(event_id: 1234)
+client.events.stories(event_id: 1234)
+```
+
+#### Series
+
+```ruby
+client.series.list
+client.series.retrieve(series_id: 1234)
+client.series.comics(series_id: 1234)
+client.series.events(series_id: 1234)
+client.series.creators(series_id: 1234)
+client.series.characters(series_id: 1234)
+client.series.stories(series_id: 1234)
+```
+
+#### Stories
+
+```ruby
+client.stories.list
+client.stories.retrieve(story_id: 1234)
+client.stories.comics(story_id: 1234)
+client.stories.events(story_id: 1234)
+client.stories.creators(story_id: 1234)
+client.stories.characters(story_id: 1234)
+client.stories.series(story_id: 1234)
+```
+
+## Docs
+
+- Browse the painstakingly documented [RubyDoc](https://rubydoc.info/gems/harkness).
+- View the interactive [API tester at Marvel](https://developer.marvel.com/docs).
+
+## Contributing
+
+See [contributing](CONTRIBUTING.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting with the Harkness project is expected to follow the [code of conduct](https://github.com/duffn/harkness/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/harkness.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/harkness/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "harkness"
+  spec.version = Harkness::VERSION
+  spec.authors = ["duffn"]
+
+  spec.summary = "A library for working (playing) with the Marvel API."
+  spec.description = "Dive into the Marvel universe with this comprehensive Ruby library for the Marvel API at https://developer.marvel.com."
+  spec.homepage = "https://github.com/duffn/harkness"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/duffn/harkness"
+  spec.metadata["changelog_uri"] = "https://github.com/duffn/harkness/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.7"
+  spec.add_dependency "shale", "~> 0.9.0"
+
+  spec.add_development_dependency "redcarpet", "~> 3.6"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.18"
+  spec.add_development_dependency "simplecov", "~> 0.22.0"
+  spec.add_development_dependency "simplecov-cobertura", "~> 2.1"
+  spec.add_development_dependency "timecop", "~> 0.9.6"
+  spec.add_development_dependency "vcr", "~> 6.1"
+  spec.add_development_dependency "webmock", "~> 3.18"
+  spec.add_development_dependency "yard", "~> 0.9.28"
+end

data/lib/harkness/client.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Harkness
+  class Client
+    # The base URL for the Marvel API.
+    BASE_URL = "https://gateway.marvel.com/v1/public"
+
+    # The public key for the Marvel API.
+    # @return [String] the public key for the Marvel API.
+    attr_reader :public_key
+    # The private key for the Marvel API.
+    # @return [String] the private key for the Marvel API.
+    attr_reader :private_key
+
+    # Initialize a client.
+    # @param public_key [String] the public key for the Marvel API.
+    # @param private_key [String] the private key for the Marvel API.
+    # @param logger [Boolean] enable Faraday request logging.
+    def initialize(public_key:, private_key:, logger: false)
+      @public_key = public_key
+      @private_key = private_key
+      @logger = logger
+    end
+
+    # The character resource.
+    # @return [Harkness::CharacterResource] the character resource.
+    def characters
+      CharacterResource.new(self)
+    end
+
+    # The comics resource.
+    # @return [Harkness::ComicResource] the comic resource.
+    def comics
+      ComicResource.new(self)
+    end
+
+    # The creators resource.
+    # @return [Harkness::CreatorResource] the creator resource.
+    def creators
+      CreatorResource.new(self)
+    end
+
+    # The events resource.
+    # @return [Harkness::EventResource] the event resource.
+    def events
+      EventResource.new(self)
+    end
+
+    # The series resource.
+    # @return [Harkness::SeriesResource] the series resource.
+    def series
+      SeriesResource.new(self)
+    end
+
+    # The stories resource.
+    # @return [Harkness::StoryResource] the story resource.
+    def stories
+      StoryResource.new(self)
+    end
+
+    # The Faraday connection to use for API requests.
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :json
+
+        conn.response :logger if @logger
+      end
+    end
+  end
+end

data/lib/harkness/error.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Harkness
+  module Error
+    class Error < StandardError; end
+
+    # Raised when the API endpoint returns the HTTP status code 400.
+    class BadRequest < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 401.
+    class Unauthorized < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 403.
+    class Forbidden < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 404.
+    class NotFound < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 406.
+    class NotAcceptable < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 409.
+    class Conflict < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 422.
+    class Unprocessable < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 429.
+    class TooManyRequests < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 500.
+    class InternalServerError < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 502.
+    class BadGateway < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < Error; end
+
+    # Raised when the API endpoint returns the HTTP status code 522.
+    class ConnectionTimedOut < Error; end
+
+    # HTTP status codes mapped to error classes.
+    STATUS_MAPPINGS = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      406 => NotAcceptable,
+      409 => Conflict,
+      422 => Unprocessable,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      503 => ServiceUnavailable,
+      522 => ConnectionTimedOut
+    }.freeze
+  end
+end

data/lib/harkness/models/base/data_container.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Harkness
+  module Base
+    # Container class that holds pagination information.
+    class DataContainer < Shale::Mapper
+      # @!attribute [r] offset
+      #   @return [Integer] the requested offset (number of skipped results) of the call.
+      attribute :offset, Shale::Type::Integer
+      # @!attribute [r] limit
+      #   @return [Integer] the requested result limit.
+      attribute :limit, Shale::Type::Integer
+      # @!attribute [r] total
+      #   @return [Integer] the total number of resources available given the current filter set.
+      attribute :total, Shale::Type::Integer
+      # @!attribute [r] count
+      #   @return [Integer] the total number of results returned by this call.
+      attribute :count, Shale::Type::Integer
+    end
+  end
+end