mtg_sdk 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b2532e6c12720acfd3e16467b1165d9de12f8cd
-  data.tar.gz: 49c72b92e713b07f91c8883deb78bab134719d81
+  metadata.gz: 6710db90dfe637bdd5d2994d720efd7fa6d67a11
+  data.tar.gz: e2d54bf4f36a29feca515e47f681423b708d7240
 SHA512:
-  metadata.gz: dbb2c15915d3a6f5aed7b59b582d350668d96996b22368ed0a416e5c36d8a26f6b38737f94d96456c35cbbbbcf9dbbd9d9e260d3f6750ed2019b19ec4027e588
-  data.tar.gz: fa2272cc64887c3b0d8ab3f4fbdc5b0ef190062f2e02a566fe2521d932aa7680590dc02c0d122d3cd597b0c219fa54473afd740f2edc2e67ae42d40c3e6083bb
+  metadata.gz: f3db4337be3f5713ea869e1daa86f7c37f663376d7a196f363f1c22ef0ba845cf37e4257b9e4e24096c0a71beec34fe4adb9bed612d2ff932cb64e4dcf877d01
+  data.tar.gz: 4010b3ec452aec330656785b92e93ad03ceb2968c291ea5e7f64c5db93136b626d9b7a4c261bb1e27804273e9488e697a2e39631eb384839cb7c11629312091a

data/.gitignore

@@ -14,6 +14,7 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+test/fixtures
 tmp
 *.bundle
 *.so

data/lib/mtg_sdk.rb

@@ -10,6 +10,7 @@ require "mtg_sdk/subtype"
 require "mtg_sdk/supertype"
 require "mtg_sdk/changelog"
 require "mtg_sdk/rest_client"
+require "mtg_sdk/query_builder"
 
 module MTG
   API_URL = 'https://api.magicthegathering.io'

data/lib/mtg_sdk/card.rb

@@ -1,65 +1,44 @@
 require_relative 'representers/card_representer'
-require_relative 'resource'
 
 module MTG
-  class Card < Resource
+  class Card
     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
-                
+    
+    # Get the resource string
+    #
+    # @return [String] The API resource string
+    def self.Resource
+      "cards"
+    end
+    
     # 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)
+      QueryBuilder.new(Card).find(id)
     end
 
     # Get all cards from a query by paging through data
     #
     # @return [Array<Card>] Array of Card objects
     def self.all
-      cards = []
-      page = 0
-         
-      while true
-        where(page: page += 1)
-        response = RestClient.get('cards', query[:parameters])
-        data = response.body['cards']      
-        data.empty? ? break : data.each {|card| cards << new.from_json(card.to_json)}
-      end
-      
-      @query = nil
-      cards
+      QueryBuilder.new(Card).all
     end
     
-    # Execute a query and convert the response
-    # into a list of Card objects
+    # Adds a parameter to the hash of query parameters
     #
-    # @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
+    # @param args [Hash] the query parameter
+    # @return [QueryBuilder] the QueryBuilder
+    def self.where(args)
+      QueryBuilder.new(Card).where(args)
     end
   end
 end

data/lib/mtg_sdk/changelog.rb

@@ -1,28 +1,24 @@
 require_relative 'representers/changelog_representer'
-require_relative 'resource'
 
 module MTG
-  class Changelog < Resource
+  class Changelog
     include Roar::JSON
-    include RestClient
     include ChangelogRepresenter
   
     attr_accessor :version, :details, :release_date
     
+    # Get the resource string
+    #
+    # @return [string] The API resource string
+    def self.Resource
+      "changelogs"
+    end
+    
     # 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
+      QueryBuilder.new(Changelog).all
     end
   end
 end

data/lib/mtg_sdk/query_builder.rb

@@ -0,0 +1,66 @@
+module MTG
+  class QueryBuilder
+    include RestClient
+    attr_accessor :type, :query
+    
+    def initialize(type)
+      @type = type
+      @query = {}
+    end
+
+    # Adds a parameter to the hash of query parameters
+    #
+    # @param args [Hash] the query parameter
+    # @return [QueryBuilder] the QueryBuilder
+    def where(args)
+      @query.merge!(args)
+      self
+    end
+    
+    # Find a single resource by the resource id
+    #
+    # @param id [String] the resource id
+    # @return [Object] the Type object response
+    def find(id)
+      response = RestClient.get("#{@type.Resource}/#{id}")
+      singular_resource = @type.Resource[0...-1]
+      if response.body[singular_resource].nil?
+        raise ArgumentError, 'Resource not found'
+      end
+      
+      type.new.from_json(response.body[singular_resource].to_json)
+    end
+    
+    # Get all resources from a query by paging through data
+    #
+    # @return [Array<Object>] Array of resources
+    def all
+      list = []
+      page = 1
+      fetch_all = true
+
+      if @query.has_key?(:page)
+        page = @query[:page]
+        fetch_all = false
+      end
+      
+      while true
+        response = RestClient.get(@type.Resource, @query)
+        data = response.body[@type.Resource]      
+        if !data.empty?
+          data.each {|item| list << @type.new.from_json(item.to_json)}
+          
+          if !fetch_all
+            break
+          else
+            where(page: page += 1)
+          end
+        else
+          break
+        end
+      end
+
+      return list
+    end
+  end
+end

data/lib/mtg_sdk/set.rb

@@ -1,9 +1,9 @@
 require_relative 'representers/set_representer'
 require_relative 'card'
-require_relative 'resource'
+require_relative 'rest_client'
 
 module MTG
-  class Set < Resource
+  class Set
     include Roar::JSON
     include SetRepresenter
     include RestClient
@@ -12,29 +12,30 @@ module MTG
                   :release_date, :gatherer_code, :magic_cards_info_code, :booster,
                   :old_code, :block, :online_only
 
+    # Get the resource string
+    #
+    # @return [string] The API resource string
+    def self.Resource
+      "sets"
+    end
+
     # 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)
+      QueryBuilder.new(Set).find(code)
     end
     
     # Get all sets from a query
     #
     # @return [Array<Set>] Array of Set objects
     def self.all
-      get
+      QueryBuilder.new(Set).all
     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)
@@ -46,25 +47,7 @@ module MTG
         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

@@ -1,7 +1,5 @@
-require_relative 'resource'
-
 module MTG
-  class Subtype < Resource
+  class Subtype
     include RestClient
     
     # Get all subtypes

data/lib/mtg_sdk/supertype.rb

@@ -1,7 +1,5 @@
-require_relative 'resource'
-
 module MTG
-  class Supertype < Resource
+  class Supertype
     include RestClient
     
     # Get all supertypes

data/lib/mtg_sdk/type.rb

@@ -1,7 +1,5 @@
-require_relative 'resource'
-
 module MTG
-  class Type < Resource
+  class Type
     include RestClient
     
     # Get all types

data/lib/mtg_sdk/version.rb

@@ -1,3 +1,3 @@
 module MTG
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

data/test/card_test.rb

@@ -40,34 +40,27 @@ class CardTest < Minitest::Test
     end
   end
   
-  def test_where_and_get_returns_cards
+  def test_where_with_page_size_and_page_returns_cards
     VCR.use_cassette('query_cards_pageSize') do
-      cards = MTG::Card.where(pageSize: 10).get
+      cards = MTG::Card.where(pageSize: 10).where(page: 1).all
 
-      # make sure we got a ton of cards
+      # make sure we got only 10 cards back
       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
-  
+
   def test_all_returns_cards
     VCR.use_cassette('all_filtered') do
       cards = MTG::Card.where(supertypes: 'legendary')
                        .where(subtypes: 'elf,warrior')
                        .all
-                       
-      puts cards.length
+
+      first_card = cards[0]
+      assert first_card.supertypes.include? 'Legendary'
+      assert first_card.subtypes.include? 'Elf'
+      assert first_card.subtypes.include? 'Warrior'
     end
   end
 end

data/test/set_test.rb

@@ -23,6 +23,14 @@ class SetTest < Minitest::Test
     end
   end
   
+  def test_all_returns_all_sets
+    VCR.use_cassette('all_sets') do
+      sets = MTG::Set.all
+      
+      assert sets.length > 100
+    end
+  end
+  
   def test_generate_booster_returns_cards
     VCR.use_cassette('booster') do
       cards = MTG::Set.generate_booster('ktk')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtg_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Backes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,13 +198,13 @@ files:
 - lib/mtg_sdk/configuration.rb
 - lib/mtg_sdk/foreign_name.rb
 - lib/mtg_sdk/legality.rb
+- lib/mtg_sdk/query_builder.rb
 - lib/mtg_sdk/representers/card_representer.rb
 - lib/mtg_sdk/representers/changelog_representer.rb
 - lib/mtg_sdk/representers/foreign_name_representer.rb
 - lib/mtg_sdk/representers/legality_representer.rb
 - lib/mtg_sdk/representers/ruling_representer.rb
 - lib/mtg_sdk/representers/set_representer.rb
-- lib/mtg_sdk/resource.rb
 - lib/mtg_sdk/rest_client.rb
 - lib/mtg_sdk/ruling.rb
 - lib/mtg_sdk/set.rb
@@ -216,18 +216,6 @@ files:
 - test/card_test.rb
 - test/changelog_test.rb
 - test/configuration_test.rb
-- test/fixtures/all_changelogs.yml
-- test/fixtures/all_filtered.yml
-- test/fixtures/all_subtypes.yml
-- test/fixtures/all_supertypes.yml
-- test/fixtures/all_types.yml
-- test/fixtures/booster.yml
-- test/fixtures/invalid_code.yml
-- test/fixtures/invalid_id.yml
-- test/fixtures/one_card.yml
-- test/fixtures/one_set.yml
-- test/fixtures/query_cards_pageSize.yml
-- test/fixtures/query_zurgo.yml
 - test/set_test.rb
 - test/subtype_test.rb
 - test/supertype_test.rb
@@ -261,18 +249,6 @@ test_files:
 - test/card_test.rb
 - test/changelog_test.rb
 - test/configuration_test.rb
-- test/fixtures/all_changelogs.yml
-- test/fixtures/all_filtered.yml
-- test/fixtures/all_subtypes.yml
-- test/fixtures/all_supertypes.yml
-- test/fixtures/all_types.yml
-- test/fixtures/booster.yml
-- test/fixtures/invalid_code.yml
-- test/fixtures/invalid_id.yml
-- test/fixtures/one_card.yml
-- test/fixtures/one_set.yml
-- test/fixtures/query_cards_pageSize.yml
-- test/fixtures/query_zurgo.yml
 - test/set_test.rb
 - test/subtype_test.rb
 - test/supertype_test.rb