scryfall_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01e384df2d2e8cdc58079f01f3d20106db0482effa52d0430b13dc19cd010849
+  data.tar.gz: 169e9a3975f5cedf55417458f73ad1f91d42b09e2e8008f49e54f9bb07dd0a3e
+SHA512:
+  metadata.gz: b8f9086ad6e7d6308ee7c60fd189c02a4805c3542b50f90a9b16248254025e0050be8f5fa4d8988dfadff60ae005428d77fbb4b0a9b3f3abaf9067d295c8e892
+  data.tar.gz: 74561f8868c0326a4de5cc0cf926e226b0bb7f31dc1f0e972d411c810e7df26d4057ca06b3208bc78d7f984ecda5a7464866393cd61a4ad3a82d86847bd877d5

data/.gitignore

@@ -0,0 +1,120 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at walker@walkergriggs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scryfall.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Walker Griggs
+
+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,71 @@
+<img alt="# scryfall_rb" src="./assets/scryfall_rb.png" width="50%">
+
+scryfall_rb is an open source Ruby client library for [Scryfall's](https://scryfall.com/) [API](https://scryfall.com/docs/api) 
+
+Features
+--------
+
+* Card lookup with Scryfall's fulltext query.
+* Full catalog support for cards, artists, and types
+* Set details by name (set code) or id
+* Extensible error handling with Scryfall specific details
+
+Future Features
+---------------
+* Card image querying with options for downloading to local filesystem.
+* `.next()` for lists with a none-null `has-next` value.
+* Improved support for fulltext queries, including argument parsing. Currently, oracle text must be split by whitespace (ie. `"oracle:draw oracle:a oracle:card" => "oracle%3Adraw%20oracle%3Aa%20oracle%3Acard"`. That process can be further simplified.
+
+Stretch Features
+----------------
+* OAuth for 3rd party applications. Currently this feature is in a closed beta and registration is closed to the general public. This feature will be tackles once OAuth support goes GA
+
+All class/method names follow Scryfall's own naming convention, so their [API documenation](https://scryfall.com/docs/api) is the base place to look if you have any questions.
+
+Examples
+--------
+
+All `card` fields returned by Scryfall are packed into the `Scryfall::Card` object (including all image URI's for download).
+```
+card = Scryfall::Card.random
+
+card.class
+=> Scryfall::Card
+
+card.inspect
+=> "#<Scryfall::Card:0x00005624429b77f8 @attributes=#<OpenStruct object=\"card\", id=\"442b8c31-f346-4984-9159-2dce6a7485ac\", oracle_id=\"d0f06250-25a5-4003-8f3a-6d85ef32ea10\", name=\"Keening Stone\", lang=\"en\", released_at=\"2016-11-11\", mana_cost=\"{6}\", cmc=6.0, type_line=\"Artifact\", oracle_text=\"{5}, {T}: Target player puts the top X cards of their library...
+
+```
+
+Full text queries are done in plain text -- no need to [properly encoding](https://en.wikipedia.org/wiki/Percent-encoding) the query strings. For large query results, pagination is supported. Users are left to request 'next_page' values as needed.
+
+```
+cards = Scryfall::Card.search("type:sorcery color:U")
+
+cards.class
+=> Scryfall::List
+
+cards.total_cards
+=> 422
+
+cards.next_page
+=> "https://api.scryfall.com/cards/search?format=json&include_extras=false&include_multilingual=false&order=name&page=2&q=type%3Asorcery+color%3Au&unique=cards"
+```
+
+
+License
+-------
+The scryfall_rb client is available under the terms of the MIT License.
+
+Use of Scryfall/WoTC Data
+--------------------
+
+As per [Scryfall's own documentation](https://scryfall.com/docs/api), Scryfall provides their card data and image database free of charge for the primary purpose of creating additional Magic software, performing research, or creating community content (such as videos, set reviews, etc) about Magic and related products as part of the Wizards of the Coast Fan Content Policy,.
+
+When using Scryfall data, you must adhere to the following guidelines:
+
+ * You may not use Scryfall logos or use the Scryfall name in a way that implies Scryfall has endorsed you, your work, or your product.
+ * You may not require anyone to make payments, take surveys, agree to subscriptions, rate your content, or create accounts in exchange for access to Scryfall data.
+ * You may not use Scryfall data to create new games, or to imply the information and images are from any other game besides Magic: The Gathering.
+ 
+ This software is not produced, endorsed, or supported by Wizards of the Coast or Scryfall.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scryfall"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/request/request.rb

@@ -0,0 +1,9 @@
+class Request
+  attr_accessor :params, :headers, :body
+
+  def initialize(params, headers=nil, body=nil)
+    @params = params
+    @headers = headers
+    @body = body
+  end
+end

data/lib/scryfall.rb

@@ -0,0 +1,27 @@
+require "delegate"
+require "httparty"
+
+require "request/request"
+require "scryfall/version"
+require "scryfall/configuration"
+require "scryfall/errors"
+require "scryfall/client"
+require "scryfall/connection"
+require "scryfall/card"
+require "scryfall/catalog"
+require "scryfall/set"
+require "scryfall/list"
+
+module Scryfall
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/scryfall/card.rb

@@ -0,0 +1,145 @@
+module Scryfall
+
+  class Card < Client
+
+    class << self
+
+      # Returns a List contained Cards found using a fulltext search string. This string supports the same fulltext
+      # search system that the main site uses. (https://scryfall.com/docs/syntax)
+      # https://scryfall.com/docs/api/cards/search
+      #
+      # @param q       [String] A fulltext search query. Make sure that your parameter is properly encoded.
+      # @param unique  [String] Specifies if Scryfall should remove "duplicate" results in your query. (cards, art
+      #                         prints)
+      # @param order   [String] The method to sort returned cards. (name, set, released, rarity, color, usd, tix, eur,
+      #                         cmc, power, toughness, edhrec, artist)
+      # @param dir     [String] The direction to sort cards. (auto, asc, desc)
+      # @param include_extras [Boolean] If true, extra cards (tokens, planes, etc.) will be included. Equivalent to
+      #                          adding include:extras to the fulltext search. Defaults to false.
+      # @param include_multilingual [Boolean] If true, cards in every language supported by Scryfall will be included.
+      # @param include_variations [Boolean] If true, rare care variations will be included. (Hairy Runesword, etc)
+      # @param page    [Integer] The apge number to return
+      # @param format  [String] The data format to return (json or csv)
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def search(q, unique: "cards", order: "name", dir: "auto", include_extras: false, include_multilingual: false, include_variations: false, page: 1, format: "json", pretty: false)
+        params = {
+            q: q,
+            unique: unique,
+            order: order,
+            dir: dir,
+            include_extras: include_extras,
+            include_multilingual: include_multilingual,
+            include_variations: include_variations,
+            page: page,
+            format: format,
+            pretty: pretty
+        }
+
+        req = Request.new(params = params,
+                          headers = nil,
+                          body = nil)
+
+        Scryfall::Search.get("/cards/search", self, req)
+      end
+
+      # Returns a Card based on a name search string.
+      # https://scryfall.com/docs/api/cards/named
+      #
+      # @param name    [String] Name of the card to retrieve
+      # @param mode    [String] The level of search specificity ('exact' or 'fuzzy')
+      # @param set     [String] A set code to limit the search to one set.
+      # @param format  [String] The data format to return (json, text, or image)
+      # @param face    [String] If using the image format and this parameter has the value 'back', the back of the card
+      #                         will be returned. Will return a 404 if this card has no back face.
+      # @param version [String] The image version to return when using the 'image' format (small, normal, large, png,
+      #                         art_crop, or border_crop)
+      # @param pretty [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def named(name, mode: "exact", set: nil, format: "json", face: nil, version: "large", pretty: false)
+        params = {
+            mode => name,
+            set: set,
+            format: format,
+            face: face,
+            version: version,
+            pretty: pretty
+        }
+
+        req = Request.new(params = params,
+                          headers = nil,
+                          body = nil)
+
+        Scryfall::Card.new JSON.parse(connection.get("/cards/named", req).body)
+      end
+
+      # Returns a Catalog object container up to 20 full English card names that could be auto-completions of the given
+      # string parameter
+      # https://scryfall.com/docs/api/cards/autocomplete
+      #
+      # @param q       [String] The string to autocomplete
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def autocomplete(q, format: "json", pretty: false)
+        req = Request.new(
+                         params = {q: q},
+                         headers = nil,
+                         body = nil)
+
+        Scryfall::Catalog.new JSON.parse(connection.get("/cards/autocomplete", req).body)
+      end
+
+      # Returns a single, random Card object.
+      # https://scryfall.com/docs/api/cards/random
+      #
+      # @param q       [String] An optional fulltext search query to filter the pool of random cards. Make sure that
+      #                         your parameter is properly encoded (https://en.wikipedia.org/wiki/Percent-encoding)
+      # @param format  [String] The data format to return (json, text, or image)
+      # @param face    [String] If using the image format and this parameter has the value 'back', the back of the card
+      #                         will be returned. Will return a 404 if this card has no back face.
+      # @param version [String] The image version to return when using the 'image' format (small, normal, large, png,
+      #                         art_crop, or border_crop)
+      # @param pretty [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.      # @param face    [String]
+      def random(q: nil, format: "json", face: nil, version: "large", pretty: false)
+        params = {
+            q: q,
+            format: format,
+            face: face,
+            version: version,
+            pretty: pretty
+        }
+
+        req = Request.new(params = params,
+                          headers = nil,
+                          body = nil)
+
+        Scryfall::Card.new JSON.parse(connection.get("/cards/random", req).body)
+      end
+
+      # Accepts a JSON array of card identifiers, and returns a List object with the collection of requested cards.
+      # A maximum of 75 card references may be submitted per request.
+      # https://scryfall.com/docs/api/cards/collection
+      #
+      # @param identifiers [Array] An array of JSON objects, each one a card identifier.
+      # @param pretty  [Boolean] If true, the returend JSON will be prettified. Avoid using for production code.
+      def collection(identifiers, pretty: false)
+        req = Request.new(params = nil,
+                          headers = {'Content-Type' => 'application/json'},
+                          body = identifiers)
+
+        Scryfall::Search.post("/cards/collection", self, req)
+      end
+
+      # Returns a single card with the given Scryfall ID.
+      # https://scryfall.com/docs/api/cards/id
+      #
+      # @param id [String] ID of the card to retrieve
+      # @return [Scryfall::Card] the card
+      def id(id)
+        req = Request.new(params = nil,
+                          headers = nil,
+                          body = nil)
+
+        Scryfall::Card.new JSON.parse(connection.get("/cards/#{id}", req).body)
+      end
+    end
+  end
+end

data/lib/scryfall/catalog.rb

@@ -0,0 +1,146 @@
+module Scryfall
+  class Catalog < Client
+
+    attr_reader :uri, :total_values, :data
+
+    def initialize(contents)
+      @uri = contents["uri"]
+      @total_values = contents["total_values"]
+      @data = contents["data"]
+    end
+
+    class << self
+
+      # Returns a Catalog of all nontoken English card names in Scryfall's database.V
+      # https://scryfall.com/docs/api/catalogs/card-names
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def card_names(format: "json", pretty: false)
+        request_catalogue("/catalog/card-names", format, pretty)
+      end
+
+      # Returns a Catalog of all canonical artist names in Scryfall's database.
+      # https://scryfall.com/docs/api/catalogs/artist-names
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def artist_names(format: "json", pretty: false)
+        request_catalogue("/catalog/artist-names", format, pretty)
+      end
+
+      # Returns a Catalog of all English words, of length 2 or more, that could appear in a card name.
+      # https://scryfall.com/docs/api/catalogs/word-bank
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def word_bank(format: "json", pretty: false)
+        request_catalogue("/catalog/word-bank", format, pretty)
+      end
+
+      # Returns a Catalog of all creature types in Scryfall's database.
+      # https://scryfall.com/docs/api/catalogs/creature-types
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def creature_types(format: "json", pretty: false)
+        request_catalogue("/catalog/creature-types", format, pretty)
+      end
+
+      # Returns a Catalog of all planeswalker types in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/planeswalker-types
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def planeswalker_types(format: "json", pretty: false)
+        request_catalogue("/catalog/planeswalker-types", format, pretty)
+      end
+
+      # Returns a Catalog of all land types in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/land-types
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def land_types(format: "json", pretty: false)
+        request_catalogue("/catalog/land-types", format, pretty)
+      end
+
+      # Returns a Catalog of all artifact types in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/artifact-types
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def artifact_types(format: "json", pretty: false)
+        request_catalogue("/catalog/artifact-types", format, pretty)
+      end
+
+      # Returns a Catalog of all enchantment types in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/enchantment-types
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def enchantment_types(format: "json", pretty: false)
+        request_catalogue("/catalog/enchantment-types", format, pretty)
+      end
+
+      # Returns a Catalog of all spell types in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/spell-types
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def spell_types(format: "json", pretty: false)
+        request_catalogue("/catalog/spell-types", format, pretty)
+      end
+
+      # Returns a Catalog of all possible values for a creature or vehicle's power in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/powers
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def powers(format: "json", pretty: false)
+        request_catalogue("/catalog/powers", format, pretty)
+      end
+
+      # Returns a Catalog of all possible values for a creature or vehicle's toughness in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/toughnesses
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def toughnesses(format: "json", pretty: false)
+        request_catalogue("/catalog/toughnesses", format, pretty)
+      end
+
+      # Returns a Catalog of all possible values for a planeswalker's loyalty in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/loyalties
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def loyalties(format: "json", pretty: false)
+        request_catalogue("/catalog/loyalties", format, pretty)
+      end
+
+      # Returns a Catalog of all watermarks in Scryfall's database
+      # https://scryfall.com/docs/api/catalogs/loyalties
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def watermarks(format: "json", pretty: false)
+        request_catalogue("/catalog/watermarks", format, pretty)
+      end
+
+      # Forms Request and calls connection. Used to DRY out the preceding catalog API.
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def request_catalogue(path, format, pretty)
+        req = Request.new(
+            params = {format: format, pretty: pretty},
+            headers = nil,
+            body = nil)
+
+        Scryfall::Catalog.new JSON.parse(connection.get(path, req).body)
+      end
+
+    end
+  end
+end

data/lib/scryfall/client.rb

@@ -0,0 +1,34 @@
+module Scryfall
+
+  class Client
+
+    def initialize(attrs = {})
+      @attributes = OpenStruct.new(attrs)
+    end
+
+    def to_h
+      @attributes.to_h
+    end
+
+    # @private
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Client.new(attribute) : attribute
+    end
+
+    def connection
+      self.class.connection
+    end
+
+    class << self
+      def connection
+        @@connection ||= Connection.new
+      end
+
+      def connection=(conn)
+        @@connection = conn
+      end
+    end
+  end
+end
+

data/lib/scryfall/configuration.rb

@@ -0,0 +1,8 @@
+module Scryfall
+
+  class Configuration
+    def initialize
+      @logger = Logger.new(STDOUT)
+    end
+  end
+end

data/lib/scryfall/connection.rb

@@ -0,0 +1,48 @@
+module Scryfall
+
+  class Connection
+    include HTTParty
+    
+    DEFAULT_VERSION = "v1"
+    DEFAULT_API_BASE_URI = "https://api.scryfall.com"
+
+    def initialize(version: DEFAULT_VERSION, api_base_uri: DEFAULT_API_BASE_URI)
+      @api_version = version
+      @api_base_uri = api_base_uri
+
+      Scryfall::Connection.base_uri @api_base_uri
+    end
+
+    def get(path, req)
+      request :get, path, req
+    end
+
+    def post(path, req)
+      request :post, path, req
+    end
+
+    def request(verb, path, req)
+      raise ArgumentError.new "Invalid HTTP verb #{verb}" unless [:get, :post].include?(verb)
+
+      response = begin
+        self.class.public_send verb, path, query: req.params, headers: req.headers, body: req.body # debug_output: $stdout
+      end
+
+      status = response.respond_to?(:status) ? response.status : response.code
+      case status
+      when 200..299
+        response
+      when 404
+        raise Scryfall::NotFoundError.new(error_details(response))
+      else
+        raise Scryfall::Error.new(error_details(response))
+      end
+
+      response
+    end
+
+    def error_details(response)
+      JSON.parse(response.body)["details"]
+    end
+  end
+end

data/lib/scryfall/errors.rb

@@ -0,0 +1,4 @@
+module Scryfall
+  class Error < StandardError; end
+  class NotFoundError < Error; end
+end

data/lib/scryfall/list.rb

@@ -0,0 +1,35 @@
+module Scryfall
+
+  class List < SimpleDelegator
+    attr_reader :has_more, :next_page, :total_cards, :warnings
+
+    def initialize(contents, klass)
+      @has_more    = contents["has_more"]
+      @next_page   = contents["next_page"]
+      @total_cards = contents["total_cards"]
+      @warnings    = contents["warnings"]
+
+      data = contents["data"].map do |obj|
+        klass.new obj.to_hash
+      end
+
+      super(data)
+    end
+  end
+
+  class Search < Client
+
+    class << self
+
+      def get(url, klass, params)
+        data = JSON.parse(connection.get(url, params).body)
+        List.new(data, klass)
+      end
+
+      def post(url, klass, request)
+        data = JSON.parse(connection.post(url, request).body)
+        List.new(data, klass)
+      end
+    end
+  end
+end

data/lib/scryfall/set.rb

@@ -0,0 +1,52 @@
+module Scryfall
+
+  class Set < Client
+
+    class << self
+
+      # Returns a List object of all Sets on Scryfall
+      # https://scryfall.com/docs/api/sets/all
+      #
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def all(format: "json", pretty: false)
+        req = Request.new(
+            params: {format: format, pretty: pretty},
+            headers: nil,
+            body: nil)
+
+        Scryfall::Search.get("/sets", self, req)
+      end
+
+      # Returns a Set with the given set code. The code can be either the code or the mtgo_code for the set.
+      # https://scryfall.com/docs/api/sets/code
+      #
+      # @param code    [String] The three to five letter set code
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def code(code, format: "json", pretty: false)
+        req = Request.new(
+            params: {format: format, pretty: pretty},
+            headers: nil,
+            body: nil)
+
+        Scryfall::Set.new JSON.parse(connection.get("/sets/#{code}", req).body)
+      end
+
+      # Returns a Set with the given Scryfall ID.
+      # https://scryfall.com/docs/api/sets/id
+      #
+      # @param id      [String] The Scryfall set ID
+      # @param format  [String] The data format to return. This method only supports json.
+      # @param pretty  [Boolean] If true, the returned JSON will be prettified. Avoid using for production code.
+      def id(id, format: "json", pretty: false)
+        req = Request.new(
+            params: {format: format, pretty: pretty},
+            headers: nil,
+            body: nil)
+
+        Scryfall::Set.new JSON.parse(connection.get("/sets/#{id}", req).body)
+      end
+    end
+  end
+end

data/lib/scryfall/version.rb

@@ -0,0 +1,3 @@
+module Scryfall
+  VERSION = "0.1.0"
+end

data/scryfall.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scryfall/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scryfall_rb"
+  spec.version       = Scryfall::VERSION
+  spec.authors       = ["Walker Griggs"]
+  spec.email         = ["walker@walkergriggs.com"]
+
+  spec.summary       = %q{A lightweight Ruby client for the Scryfall API.}
+  spec.homepage      = "https://github.com/walkergriggs/scryfall_rb"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/walkergriggs/scryfall_rb"
+    spec.metadata["changelog_uri"] = "https://github.com/walkergriggs/scryfall_rb/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: scryfall_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Walker Griggs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- walker@walkergriggs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/scryfall_rb.png
+- bin/console
+- bin/setup
+- lib/request/request.rb
+- lib/scryfall.rb
+- lib/scryfall/card.rb
+- lib/scryfall/catalog.rb
+- lib/scryfall/client.rb
+- lib/scryfall/configuration.rb
+- lib/scryfall/connection.rb
+- lib/scryfall/errors.rb
+- lib/scryfall/list.rb
+- lib/scryfall/set.rb
+- lib/scryfall/version.rb
+- scryfall.gemspec
+homepage: https://github.com/walkergriggs/scryfall_rb
+licenses: []
+metadata:
+  homepage_uri: https://github.com/walkergriggs/scryfall_rb
+  source_code_uri: https://github.com/walkergriggs/scryfall_rb
+  changelog_uri: https://github.com/walkergriggs/scryfall_rb/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: A lightweight Ruby client for the Scryfall API.
+test_files: []