mtg_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecbca7d3400b152d12b478b78169107fbd7a0db2
+  data.tar.gz: 6e6f2b0b4f5ce0b21914e38763471a9838d159e6
+SHA512:
+  metadata.gz: 7f9d8fd01135a18cb01dfd5b2b2e4b276dd0a008d557832a1a3ba0af151cf90d827d21f3d1bd75d3247ec0de1549be9f25ddbe329d7abbda7e09257e0b0cb241
+  data.tar.gz: 62eafd2a5699518aba55cd18b35487a65c536c6b61d9b326f5acd46ec52eaf4b40699b7899c743eb17e4d0722a9efd97da4b78c37fb6849fedd5489a4372b758

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.vscode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Andrew Backes
+
+MIT License
+
+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 @@
+# Magic: The Gathering SDK
+
+This is the Magic: The Gathering SDK Ruby implementation. It is a wrapper around the MTG API of magicthegathering.io.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mtg_sdk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mtg_sdk
+
+## Usage
+
+To change the API version (currently defaults to version 1)
+
+    MTG.configure do |config|
+      config.api_version = 2
+    end
+
+### Classes
+
+    Card
+    Set
+    ForeignName
+    Ruling
+    Legality
+    Subtype
+    Supertype
+    Type
+    Changelog
+
+### Properties Per Class
+
+#### Card
+
+    name
+    multiverse_id
+    layout
+    names
+    mana_cost
+    cmc
+    colors
+    type
+    supertypes
+    subtypes
+    rarity
+    text
+    flavor
+    artist
+    number
+    power
+    toughness
+    loyalty
+    variations
+    watermark
+    border
+    timeshifted
+    hand
+    life
+    reserved
+    release_date
+    starter
+    rulings
+    foreign_names
+    printings
+    original_text
+    original_type
+    legalities
+    source
+    image_url
+    set
+    id
+
+#### Set
+
+    code
+    name
+    gatherer_code
+    old_code
+    magic_cards_info_code
+    release_date
+    border
+    type
+    block
+    online_only
+    booster
+    mkm_id
+    mkm_name
+
+#### ForeignName
+
+    language
+    name
+    multiverse_id
+
+#### Ruling
+
+    date
+    text
+
+#### Legality
+
+    format
+    legality
+    
+#### Changelog
+
+    version
+    release_date
+    details
+
+### Functions Available
+
+#### Find a card by multiverse id
+
+    card = MTG::Card.find(386616)
+
+#### Filter Cards via query parameters
+
+    cards = MTG::Card.where(set: ktk).where(subtypes: 'warrior,human').get
+    
+#### Find a set by code
+
+    set = MTG::Set.find('ktk')
+    
+#### Filter sets via query parameters
+
+    sets = MTG::Set.where(name: khans).get
+    
+#### Get all Types
+
+    types = MTG::Type.all
+
+#### Get all Subtypes
+
+    subtypes = MTG::Subtype.all
+
+#### Get all Supertypes
+
+    supertypes = MTG::Supertype.all
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mtg_sdk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require_relative 'lib/mtg_sdk'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc "TODO"
+  task :cards do
+    card = MTG::Card.find(88803)
+    puts card.rulings.first.date
+
+  end

data/lib/mtg_sdk.rb

@@ -0,0 +1,32 @@
+require "mtg_sdk/version"
+require "mtg_sdk/configuration"
+require "mtg_sdk/card"
+require "mtg_sdk/legality"
+require "mtg_sdk/foreign_name"
+require "mtg_sdk/ruling"
+require "mtg_sdk/set"
+require "mtg_sdk/type"
+require "mtg_sdk/subtype"
+require "mtg_sdk/supertype"
+require "mtg_sdk/changelog"
+require "mtg_sdk/rest_client"
+
+module MTG
+  API_URL = 'https://api.magicthegathering.io'
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+end

data/lib/mtg_sdk/card.rb

@@ -0,0 +1,48 @@
+require_relative 'representers/card_representer'
+require_relative 'rest_client'
+require_relative 'resource'
+
+module MTG
+  class Card < Resource
+    include Roar::JSON
+    include CardRepresenter
+    include RestClient
+    
+    attr_accessor :name, :layout, :names, :mana_cost, :cmc, :colors, :type, :supertypes, :subtypes, :types,
+                  :rarity, :text, :flavor, :artist, :number, :power, :toughness, :loyalty, :multiverse_id, :variations,
+                  :watermark, :border, :timeshifted, :hand, :life, :reserved, :release_date, :starter,
+                  :rulings, :foreign_names, :printings, :original_text, :original_type, :legalities,
+                  :source, :image_url, :set, :id
+                
+    # Find a single card by the card multiverse id
+    #
+    # @param id [Integer] the multiverse id
+    # @return [Card] the Card object response
+    def self.find(id)
+      response = RestClient.get("cards/#{id}")
+      
+      if response.body['card'].nil?
+        raise ArgumentError, 'Card not found'
+      end
+      
+      new.from_json(response.body['card'].to_json)
+    end
+    
+    # Execute a query and convert the response
+    # into a list of Card objects
+    #
+    # @return [Array<Card>] Array of Card objects
+    def self.get
+      cards = []
+      response = RestClient.get('cards', query[:parameters])
+      data = response.body['cards']
+      
+      data.each do |card|
+        cards << new.from_json(card.to_json)
+      end
+      
+      @query = nil
+      cards
+    end
+  end
+end

data/lib/mtg_sdk/changelog.rb

@@ -0,0 +1,29 @@
+require_relative 'representers/changelog_representer'
+require_relative 'rest_client'
+require_relative 'resource'
+
+module MTG
+  class Changelog < Resource
+    include Roar::JSON
+    include RestClient
+    include ChangelogRepresenter
+  
+    attr_accessor :version, :details, :release_date
+    
+    # Get all changelogs
+    #
+    # @return [Array<Changelog>] Array of Changelog objects
+    def self.all
+      changelogs = []
+      response = RestClient.get('changelogs')
+      data = response.body['changelogs']
+      
+      data.each do |changelog|
+        changelogs << new.extend(ChangelogRepresenter).from_json(changelog.to_json)
+      end
+      
+      @query = nil
+      changelogs
+    end
+  end
+end

data/lib/mtg_sdk/configuration.rb

@@ -0,0 +1,9 @@
+module MTG
+  class Configuration
+    attr_accessor :api_version
+
+    def initialize
+      @api_version = 1
+    end
+  end
+end

data/lib/mtg_sdk/foreign_name.rb

@@ -0,0 +1,10 @@
+require_relative 'representers/foreign_name_representer'
+
+module MTG
+  class ForeignName
+    include Roar::JSON
+    include LegalityRepresenter
+  
+    attr_accessor :language, :name, :multiverse_id
+  end
+end

data/lib/mtg_sdk/legality.rb

@@ -0,0 +1,10 @@
+require_relative 'representers/legality_representer'
+
+module MTG
+  class Legality
+    include Roar::JSON
+    include LegalityRepresenter
+  
+    attr_accessor :format, :legality
+  end
+end

data/lib/mtg_sdk/representers/card_representer.rb

@@ -0,0 +1,54 @@
+require 'roar/json'
+require 'roar/coercion'
+require_relative 'legality_representer'
+require_relative 'foreign_name_representer'
+require_relative 'ruling_representer'
+require_relative '../legality'
+require_relative '../foreign_name'
+require_relative '../ruling'
+
+module MTG
+  module CardRepresenter
+    include Roar::JSON
+    include Roar::Coercion
+    
+    property :name
+    property :layout
+    property :mana_cost, as: :manaCost
+    property :cmc
+    property :type
+    property :rarity
+    property :text
+    property :flavor
+    property :artist
+    property :number
+    property :power
+    property :toughness
+    property :loyalty
+    property :multiverse_id, as: :multiverseid
+    property :watermark
+    property :border
+    property :timeshifted
+    property :hand
+    property :life
+    property :reserved
+    property :release_date, as: :release_date, type: Date
+    property :starter
+    property :original_text, as: :originalText
+    property :original_type, as: :originalType
+    property :source
+    property :set
+    property :id
+    property :image_url, as: :imageUrl
+    
+    collection :supertypes
+    collection :subtypes
+    collection :types
+    collection :colors
+    collection :variations
+    collection :printings
+    collection :legalities, extend: LegalityRepresenter, class: Legality
+    collection :rulings, extend: RulingRepresenter, class: Ruling
+    collection :foreign_names, as: :foreignNames, extend: ForeignNameRepresenter, class: ForeignName
+  end
+end

data/lib/mtg_sdk/representers/changelog_representer.rb

@@ -0,0 +1,13 @@
+require 'roar/json'
+require 'roar/coercion'
+
+module MTG
+  module ChangelogRepresenter
+    include Roar::JSON
+    include Roar::Coercion
+  
+    property :release_date, as: :releaseDate, type: Date
+    property :version
+    property :details
+  end
+end