mtg_sdk 1.0.0

data/lib/mtg_sdk/representers/foreign_name_representer.rb

@@ -0,0 +1,11 @@
+require 'roar/json'
+
+module MTG
+  module ForeignNameRepresenter
+    include Roar::JSON
+  
+    property :name
+    property :language
+    property :multiverse_id, as: :multiverseid
+  end
+end

data/lib/mtg_sdk/representers/legality_representer.rb

@@ -0,0 +1,10 @@
+require 'roar/json'
+
+module MTG
+  module LegalityRepresenter
+    include Roar::JSON
+  
+    property :format
+    property :legality
+  end
+end

data/lib/mtg_sdk/representers/ruling_representer.rb

@@ -0,0 +1,12 @@
+require 'roar/json'
+require 'roar/coercion'
+
+module MTG
+  module RulingRepresenter
+    include Roar::JSON
+    include Roar::Coercion
+  
+    property :date, type: Date
+    property :text
+  end
+end

data/lib/mtg_sdk/representers/set_representer.rb

@@ -0,0 +1,21 @@
+require 'roar/json'
+
+module MTG
+  module SetRepresenter
+    include Roar::JSON
+  
+    property :code
+    property :name
+    property :type
+    property :border
+    property :mkm_id
+    property :mkm_name
+    property :old_code, as: :oldCode
+    property :online_only, as: :onlineOnly
+    property :release_date, as: :releaseDate
+    property :gatherer_code, as: :gatherCode
+    property :magic_cards_info_code, as: :magicCardsInfoCode
+    
+    collection :booster
+  end
+end

data/lib/mtg_sdk/resource.rb

@@ -0,0 +1,21 @@
+module MTG
+  class Resource
+  
+    # Get the hash of query parameters
+    #
+    # @return [Hash] query parameters
+    def self.query
+      @query ||= {:parameters => {}}
+    end
+  
+    # Adds a parameter to the hash of query parameters
+    #
+    # @param args [Hash] the query parameter
+    # @return [Resource] the Resource
+    def self.where(args)
+      query[:parameters].merge!(args)
+      self
+    end
+    
+  end
+end

data/lib/mtg_sdk/rest_client.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module MTG
+  module RestClient
+
+    def self.get(endpoint, params=nil)
+      if params.nil?
+        query = endpoint
+      else
+        query = "#{endpoint}?#{params_to_query(params)}"
+      end
+      
+      client.get(query)
+    end
+    
+    protected
+    
+    def self.client
+      @client = Faraday.new "#{API_URL}/v#{MTG.configuration.api_version}" do |conn|
+        conn.response :xml,  :content_type => /\bxml$/
+        conn.response :json, :content_type => /\bjson$/    
+        conn.adapter Faraday.default_adapter
+      end
+    end
+            
+    def self.params_to_query(params)
+      params.map {|p, v| "#{p}=#{URI.escape(v.to_s)}"}.join('&')
+    end
+  end
+end

data/lib/mtg_sdk/ruling.rb

@@ -0,0 +1,10 @@
+require_relative 'representers/ruling_representer'
+
+module MTG
+  class Ruling
+    include Roar::JSON
+    include RulingRepresenter
+    
+    attr_accessor :date, :text
+  end
+end

data/lib/mtg_sdk/set.rb

@@ -0,0 +1,64 @@
+require_relative 'representers/set_representer'
+require_relative 'card'
+require_relative 'rest_client'
+require_relative 'resource'
+
+module MTG
+  class Set < Resource
+    include Roar::JSON
+    include SetRepresenter
+    include RestClient
+  
+    attr_accessor :code, :name, :type, :border, :mkm_id, :mkm_name,
+                  :release_date, :gatherer_code, :magic_cards_info_code, :booster,
+                  :old_code, :block, :online_only
+
+    # Find a single set by the set code
+    #
+    # @param code [String] the Set code
+    # @return [Set] a Set object
+    def self.find(code)
+      response = RestClient.get("sets/#{code}")
+      
+      if response.body['set'].nil?
+        raise ArgumentError, 'Set not found'
+      end
+      
+      new.from_json(response.body['set'].to_json)
+    end
+    
+    # Generate a booster pack for a specific set
+    #
+    # @param code [String] the Set code
+    # @return [Array<Card>] Array of Card objects
+    def self.generate_booster(code)
+      cards = []
+      response = RestClient.get("sets/#{code}/booster")
+      data = response.body['cards']
+      
+      data.each do |card|
+        cards << Card.new.from_json(card.to_json)
+      end
+      
+      @query = nil
+      cards
+    end
+    
+    # Execute a query and convert the response
+    # into a list of Set objects
+    #
+    # @return [Array<Set>] Array of Set objects
+    def self.get
+      sets = []
+      response = RestClient.get('sets', query[:parameters])
+      data = response.body['sets']
+      
+      data.each do |set|
+        sets << new.from_json(set.to_json)
+      end
+      
+      @query = nil
+      sets
+    end
+  end
+end

data/lib/mtg_sdk/subtype.rb

@@ -0,0 +1,15 @@
+require_relative 'rest_client'
+require_relative 'resource'
+
+module MTG
+  class Subtype < Resource
+    include RestClient
+    
+    # Get all subtypes
+    #
+    # @return [Array<String>]  All subtypes
+    def self.all
+      RestClient.get('subtypes').body['subtypes']
+    end
+  end
+end

data/lib/mtg_sdk/supertype.rb

@@ -0,0 +1,15 @@
+require_relative 'rest_client'
+require_relative 'resource'
+
+module MTG
+  class Supertype < Resource
+    include RestClient
+    
+    # Get all supertypes
+    #
+    # @return [Array<String>]  All supertypes
+    def self.all
+      RestClient.get('supertypes').body['supertypes']
+    end
+  end
+end

data/lib/mtg_sdk/type.rb

@@ -0,0 +1,15 @@
+require_relative 'rest_client'
+require_relative 'resource'
+
+module MTG
+  class Type < Resource
+    include RestClient
+    
+    # Get all types
+    #
+    # @return [Array<String>]  All types
+    def self.all
+      RestClient.get('types').body['types']
+    end
+  end
+end

data/lib/mtg_sdk/version.rb

@@ -0,0 +1,3 @@
+module MTG
+  VERSION = "1.0.0"
+end

data/mtg_sdk.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mtg_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mtg_sdk"
+  spec.version       = MTG::VERSION
+  spec.authors       = ["Andrew Backes"]
+  spec.email         = ["backes.andrew@gmail.com"]
+  spec.summary       = "Magic: The Gathering SDK for magicthegathering.io"
+  spec.description   = "Magic: The Gathering SDK is a wrapper around the MTG API located at magicthegathering.io"
+  spec.homepage      = "https://magicthegathering.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json"
+  spec.add_dependency "multi_json"
+  spec.add_dependency "roar"
+  spec.add_dependency "virtus"
+end

data/test/card_test.rb

@@ -0,0 +1,62 @@
+require_relative 'test_helper'
+
+class CardTest < Minitest::Test
+  def test_find_returns_one_card
+    VCR.use_cassette('one_card') do
+      card = MTG::Card.find(88803)
+
+      assert_equal 'Choice of Damnations', card.name
+      assert_equal '{5}{B}', card.mana_cost
+      assert_equal 6, card.cmc
+      assert_equal 'Sorcery — Arcane', card.type
+      assert card.colors.any?{|color| color == 'Black'}
+      assert card.types.any?{|type| type == 'Sorcery'}
+      assert card.subtypes.any?{|subtype| subtype == 'Arcane'}
+      assert_equal 'Rare', card.rarity
+      assert_equal 'SOK', card.set
+      assert_equal "Target opponent chooses a number. You may have that player lose that much life. If you don't, that player sacrifices all but that many permanents.", card.text
+      assert_equal "\"Life is a series of choices between bad and worse.\"\n—Toshiro Umezawa", card.flavor
+      assert_equal 'Tim Hildebrandt', card.artist
+      assert_equal '62', card.number
+      assert_equal 'normal', card.layout
+      assert_equal 88803, card.multiverse_id
+      assert_equal 'http://gatherer.wizards.com/Handlers/Image.ashx?multiverseid=88803&type=card', card.image_url
+      assert card.rulings.any?{|ruling| ruling.date == Date.parse('2005-06-01')}
+      assert card.foreign_names.any?{|foreign_name| foreign_name.name == '破灭抉择'}
+      assert card.printings.any?{|printing| printing == 'SOK'}
+      assert_equal "Target opponent chooses a number. You may have that player lose that much life. If you don't, that player sacrifices all but that many permanents.", card.original_text
+      assert_equal 'Sorcery — Arcane', card.original_type
+      assert card.legalities.any?{|legality| legality.format == 'Commander' && legality.legality == 'Legal'}
+      assert_equal '1c4aab072d52d283e902f2302afa255b39e0794b', card.id
+    end
+  end
+  
+  def test_find_with_invalid_id_throws_exception
+    VCR.use_cassette('invalid_id') do
+      assert_raises ArgumentError do
+        MTG::Card.find(3239482932)
+      end
+    end
+  end
+  
+  def test_where_and_get_returns_cards
+    VCR.use_cassette('query_cards_pageSize') do
+      cards = MTG::Card.where(pageSize: 10).get
+
+      # make sure we got a ton of cards
+      assert cards.length == 10
+      assert cards.kind_of?(Array)
+      assert cards.first.kind_of?(MTG::Card)
+    end
+  end
+  
+  def test_where_appends_to_query
+    VCR.use_cassette('query_zurgo') do
+      name = 'zurgo'
+      query = MTG::Card.where(name: name).query
+      parameters = query[:parameters]
+      MTG::Card.get
+      assert_equal name, parameters[:name]
+    end 
+  end
+end

data/test/changelog_test.rb

@@ -0,0 +1,12 @@
+require_relative 'test_helper'
+
+class ChangelogTest < Minitest::Test
+  def test_all_returns_all_changelogs
+    VCR.use_cassette('all_changelogs') do
+      changelogs = MTG::Changelog.all
+      
+      assert changelogs.length > 1
+      assert changelogs.any? {|changelog| changelog.version == '1.0.0'}
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,10 @@
+#test/client_test.rb
+require_relative 'test_helper'
+
+class ConfigurationTest < Minitest::Test
+  def test_defaults
+    config = MTG::Configuration.new
+
+    assert_equal 1, config.api_version
+  end
+end

data/test/fixtures/all_changelogs.yml

@@ -0,0 +1,129 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.magicthegathering.io/v1/changelogs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: 'OK '
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Thu, 21 Jan 2016 01:58:53 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d91b83f8e592fa9004064ce3a8922ce161453341533; expires=Fri, 20-Jan-17
+        01:58:53 GMT; path=/; domain=.magicthegathering.io; HttpOnly
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Etag:
+      - W/"a0ed610acb768054f18d15a50e1288ca"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 8c653097-b501-466e-a2bd-e2f11891fea3
+      X-Runtime:
+      - '0.010917'
+      Vary:
+      - Origin
+      Via:
+      - 1.1 vegur
+      Cf-Ray:
+      - 267f6aaad35910e1-ORD
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJjaGFuZ2Vsb2dzIjpbeyJpZCI6MTUsInZlcnNpb24iOiIxLjguMCIsImRl
+        dGFpbHMiOiJUbyBxdWVyeSBmb3IgYSBjYXJkIG5hbWUgYnkgbWF0Y2hpbmcg
+        dGhlIHBhcmFtZXRlciBleGFjdGx5LCB5b3Ugd2lsbCBub3cgdXNlIHF1b3Rl
+        cyBpbnN0ZWFkIG9mIHBhcmVudGhlc2Vlcy4gRXhhbXBsZTogL2NhcmRzP25h
+        bWU9XCJ6dXJnbyBoZWxtc21hc2hlclwiIiwicmVsZWFzZURhdGUiOiIyMDE2
+        LTAxLTE4In0seyJpZCI6MTQsInZlcnNpb24iOiIxLjcuMCIsImRldGFpbHMi
+        OiJBZGRlZCBzZXQ6IE9hdGggb2YgdGhlIEdhdGV3YXRjaCAoT0dXKSIsInJl
+        bGVhc2VEYXRlIjoiMjAxNi0wMS0xMiJ9LHsiaWQiOjEzLCJ2ZXJzaW9uIjoi
+        MS42LjAiLCJkZXRhaWxzIjoiQ2FuIG5vdyBxdWVyeSBjYXJkIG5hbWVzIGJ5
+        IHRoZWlyIGZvcmVpZ24gbmFtZXMgdmlhIHRoZSAnbGFuZ3VhZ2UnIHVybCBw
+        YXJhbWV0ZXIuIEV4YW1wbGU6ICAvY2FyZHM/bGFuZ3VhZ2U9c3BhbmlzaCZu
+        YW1lPVBlcnNwaWNhY2lhIGRlIFVnaW48L2JyPjwvYnI+Q29sb3JzLCB0eXBl
+        cywgc3VidHlwZXMsIGFuZCBzdXBlcnR5cGVzIGRlZmF1bHQgdG8gYSBsb2dp
+        Y2FsIGFuZCBvcGVyYXRvciB3aGVuIHF1ZXJ5aW5nLCB1bmxlc3Mgd3JhcHBl
+        ZCBpbiBzcXVhcmUgYnJhY2tldHMsIHdoaWNoIHdpbGwgdXNlIGEgbG9naWNh
+        bCBvci4gU2VlIHRoZSBkb2NzIGZvciBleGFtcGxlcy4iLCJyZWxlYXNlRGF0
+        ZSI6IjIwMTUtMTItMDEifSx7ImlkIjoxMiwidmVyc2lvbiI6IjEuNS4wIiwi
+        ZGV0YWlscyI6IkFkZGVkIHNldDogQ29tbWFuZGVyIDIwMTUgKEMxNSkiLCJy
+        ZWxlYXNlRGF0ZSI6IjIwMTUtMTEtMTcifSx7ImlkIjoxMSwidmVyc2lvbiI6
+        IjEuNC4wIiwiZGV0YWlscyI6IlVwZGF0ZWQgcnVsaW5ncyBhbmQgb3JhY2xl
+        IHRleHQgZm9yIGFsbCBjYXJkcyBpbiBhbGwgc2V0cy48L2JyPkFkZGVkIHNl
+        dDogQmF0dGxlIGZvciBaZW5kaWthciAoQkZaKTwvYnI+QWRkZWQgc2V0OiBa
+        ZW5kaWthciBFeHBlZGl0aW9uIChFWFApPC9icj5ERFA6IEZpeGVkIHRoZSAn
+        Y29sb3JzJyBmaWVsZCBmb3IgdGhlIGNhcmRzIHdpdGggJ0Rldm9pZCcuPC9i
+        cj5VR0w6IFRoZSBjYXJkICdEZW5pZWQhJyBub3cgaGFzIGEgdHlwZSBvZiAn
+        SW5zdGFudCcgaW5zdGVhZCBvZiAnSW50ZXJydXB0Jy4gVGhlIG9yaWdpbmFs
+        VHlwZSBpcyBzdGlsbCAnSW50ZXJydXB0Jy4iLCJyZWxlYXNlRGF0ZSI6IjIw
+        MTUtMTAtMDEifSx7ImlkIjoxMCwidmVyc2lvbiI6IjEuMy4yIiwiZGV0YWls
+        cyI6IldoZW4gcXVlcnlpbmcgYSBjYXJkIGJ5IG5hbWUsIHBhcmVudGhlc2Vl
+        cyBjYW4gbm93IGJlIHBsYWNlcyBhcm91bmQgdGhlIGNhcmQgbmFtZSB0byB0
+        cnkgdG8gbWF0Y2ggdGhlIG5hbWUgZXhhY3RseS4gRXhhbXBsZTogL2NhcmRz
+        P25hbWU9KHRpbmtlcikiLCJyZWxlYXNlRGF0ZSI6IjIwMTUtMDktMTUifSx7
+        ImlkIjo5LCJ2ZXJzaW9uIjoiMS4zLjEiLCJkZXRhaWxzIjoiVGhlICdmb3Jl
+        aWduTmFtZXMnICdtdWx0aXZlcnNlaWQnIGZpZWxkIGlzIG5vdyBjb3JyZWN0
+        bHkgYW4gaW50ZWdlciByYXRoZXIgdGhhbiBhIHN0cmluZy48L2JyPlBMUzog
+        VGhlIDMgZm9pbCB2ZXJzaW9uIGNhcmRzIG5vdyBjb3JyZWN0bHkgaGF2ZSBh
+        IOKYhSBwcmVmaXggaW4gdGhlICdudW1iZXInIGZpZWxkIHRvIG1hdGNoIHdo
+        YXQgaXMgcHJpbnRlZCBvbiB0aGUgcGh5c2ljYWwgY2FyZC4iLCJyZWxlYXNl
+        RGF0ZSI6IjIwMTUtMDktMTQifSx7ImlkIjo4LCJ2ZXJzaW9uIjoiMS4zLjAi
+        LCJkZXRhaWxzIjoiQWRkZWQgc2V0OiBEdWVsIERlY2tzOiBaZW5kaWthciB2
+        cy4gRWxkcmF6aSAoRERQKTwvYnI+QWRkZWQgc2V0OiBGcm9tIHRoZSBWYXVs
+        dDogQW5nZWxzIChWMTUpPC9icj5FdmVyeSBjYXJkIG5vdyBoYXMgYSB1bmlx
+        dWUgJ2lkJyBmaWVsZDwvYnI+QWRkZWQgYSAnbXVsdGl2ZXJzZWlkJyBmaWVs
+        ZCB0byB0aGUgY2FyZCAnZm9yZWlnbk5hbWVzJyBvYmplY3QgICIsInJlbGVh
+        c2VEYXRlIjoiMjAxNS0wOS0wNSJ9LHsiaWQiOjcsInZlcnNpb24iOiIxLjIu
+        MSIsImRldGFpbHMiOiJTT006IEFkZGVkIG1pc3NpbmcgJ3dhdGVybWFyaycg
+        ZmllbGQgZm9yICdSYXpvcmZpZWxkIFRocmVzaGVyJyBjYXJkPC9icj5IT1A6
+        IEZpeGVkICd0ZXh0JyBmaWVsZCBmb3IgJ01pbmFtbycgY2FyZCB0byB1c2Ug
+        Q0hBT1MgaW5zdGVhZCBvZiB7Q30gdG8gYWxpZ24gd2l0aCBvdGhlciB1cGRh
+        dGVkIG9yYWNsZSAndGV4dCcgZmllbGRzIG9uIHNpbWlsYXIgY2FyZHMiLCJy
+        ZWxlYXNlRGF0ZSI6IjIwMTUtMDgtMTQifSx7ImlkIjo2LCJ2ZXJzaW9uIjoi
+        MS4yLjAiLCJkZXRhaWxzIjoiQWRkZWQgc2V0OiBNYWdpYyBPcmlnaW5zIChP
+        UkkpPGJyLz5BZGRlZCBzZXQ6IENsYXNoIFBhY2sgKENQSyk8L2JyPkFkZGVk
+        IHNldDogQ29sbGVjdG9yJ3MgRWRpdGlvbiAoQ0VEKTwvYnI+QWRkZWQgc2V0
+        OiBJbnRlcm5hdGlvbmFsIENvbGxlY3RvcidzIEVkaXRpb24gKENFSSkiLCJy
+        ZWxlYXNlRGF0ZSI6IjIwMTUtMDctMTYifSx7ImlkIjo1LCJ2ZXJzaW9uIjoi
+        MS4xLjMiLCJkZXRhaWxzIjoiQWRkZWQgc2V0IGNvZGUgdG8gdGhlIENhcmRz
+        IHJlc291cmNlLiIsInJlbGVhc2VEYXRlIjoiMjAxNS0wNi0wNyJ9LHsiaWQi
+        OjQsInZlcnNpb24iOiIxLjEuMiIsImRldGFpbHMiOiJSZW1vdmVkICdJbWFn
+        ZU5hbWUnIGZyb20gdGhlIEpTT04gYXMgaXQgaXMgbm8gbG9uZ2VyIGFwcGxp
+        Y2FibGUuPC9icj5BZGRlZCAnaW1hZ2VVcmwnIHRvIHRoZSBjYXJkcyByZXNv
+        dXJjZS48L2JyPkZpeGVkIG1pc3NpbmcgZG9jdW1lbnRhdGlvbiBmb3IgYSBm
+        ZXcgZmllbGRzLiIsInJlbGVhc2VEYXRlIjoiMjAxNS0wNi0wMyJ9LHsiaWQi
+        OjMsInZlcnNpb24iOiIxLjEuMSIsImRldGFpbHMiOiJDYW4gbm93IHF1ZXJ5
+        IHNldHMgYnkgc2V0IG5hbWVDYW4gbm93IHF1ZXJ5IHNldHMgYnkgc2V0IG5h
+        bWUiLCJyZWxlYXNlRGF0ZSI6IjIwMTUtMDYtMDIifSx7ImlkIjoyLCJ2ZXJz
+        aW9uIjoiMS4xLjAiLCJkZXRhaWxzIjoiQWRkZWQgc2V0OiBNb2Rlcm4gTWFz
+        dGVycyAyMDE1IEVkaXRpb24gKE1NMikiLCJyZWxlYXNlRGF0ZSI6IjIwMTUt
+        MDUtMzAifSx7ImlkIjoxLCJ2ZXJzaW9uIjoiMS4wLjAiLCJkZXRhaWxzIjoi
+        Rmlyc3QgUmVsZWFzZSIsInJlbGVhc2VEYXRlIjoiMjAxNS0wNS0yOSJ9XX0=
+    http_version: 
+  recorded_at: Thu, 21 Jan 2016 01:58:53 GMT
+recorded_with: VCR 3.0.1