MtgDbClient 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b8d521c692827950e1ed1171bfe49e1435bb845
+  data.tar.gz: 11f557bef676a4264b0c8d5b42ef71db9a2957dc
+SHA512:
+  metadata.gz: c61b9c89b367010a79d8cf0aa8458453bc406d04733c0146adccab0c19be68b91390325e5a7bc15757e13d7483e06d250914400d8c5207e52c81ec824997daca
+  data.tar.gz: 4758b50b36da62231a4b63e3263900243eace1d0c2c216b4ec327c644f9b56c55fd0fd670c4678fd3de641e2cc44a00b8cbb2b2ef95ff326526890f40f7ae605

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chase Park
+
+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/MtgDbClient.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'MtgDbClient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "MtgDbClient"
+  spec.version       = MtgDbClient::VERSION
+  spec.authors       = ["Chase Park"]
+  spec.email         = ["chasepark@comcast.net"]
+  spec.description   = %q{Client gem that wraps the MtgDb Api}
+  spec.summary       = %q{Client gem that wraps the MtgDb Api}
+  spec.homepage      = "http://www.github.com/chasepark/MtgDbClient"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "httparty", "~> 0.13.1"
+end

data/README.md

@@ -0,0 +1,126 @@
+# MtgDbClient
+
+This is a simple api wrapper gem for the MtgDb Api found at 'http://api.mtgdb.info'. This is a 1:1 representation of the C# wrapper.
+
+####Dependencies
+HttParty
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'MtgDbClient'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install MtgDbClient
+
+## Usage
+To get started using MtgDbClient first setup the client
+	
+	require "mtgdbclient"
+	
+	client = MtgDbClient.new
+
+###Configuration
+	
+	MtgDbClient.configure do|config|
+		config.endpoint = 'api.mtgdb.info'
+		#default is api.mtgdb.info
+	end	
+
+
+###The following functions are currently supported:
+
+####Get Rarity Types
+returns all available rarity types.
+
+	client.get_rarity_types
+
+####Get Card Types
+returns all available card types
+	
+	client.get_card_types
+
+####Get Card Subtypes
+returns all unique subtypes available on all cards
+
+	client.get_card_subtypes
+	
+####Get Sets
+returns a list of sets
+	
+	client.get_sets
+
+####Get Set
+returns a set, specified by the three character set identifier
+
+	client.get_set(set_id)
+
+####Get Random Card In Set
+returns a random card from a specified set
+
+	client.get_random_card_from_set(set_id)
+
+####Get Sets By Id
+returns a details of the specified sets
+
+	client.get_sets_by_id([set_ids])
+
+####Get Card
+returns a card specified by the multiverse(oracle) id
+
+	client.get_card(card_id)
+
+####Get Cards By Id
+returns detaisl of specified cards
+	
+	client.get_cards_by_id([multiverse_ids])
+
+####Get Cards
+returns a list of all cards (WARNING: This takes some time to run.)
+
+	client.get_cards
+
+####Get Random Card
+returns a completely random card
+
+	client.get_random_card
+
+####Get Card By Name
+returns all instances of a card by name
+
+	client.get_card_by_name(card_name)
+	
+####Filter Cards
+returns a list of all cards with the specified filter
+
+	client.filter_cards(property, value)
+
+####Get Card In Set
+returns a card in a specified set with the collector number
+
+	client.get_card_in_set(set_id, collector_id)
+####Search
+gets a list of cards that meet the specified criteria
+
+	client.search(text, start=0, limit=0, isComplex=false)
+	
+	
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+
+##Legal
+MtgApi Notice:
+
+All information provided is copyrighted by Wizards of the Coast. This api and/or web applications on this domain are not in anyway affiliated with Wizards of the Coast.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << "-rubygems"
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/MtgDbClient/client.rb

@@ -0,0 +1,86 @@
+require "httparty"
+
+
+module MtgDbClient
+	class Client
+		include HTTParty
+		attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+		def initialize(options={})
+			merged_options = MtgDbClient.options.merge(options)
+
+			Configuration::VALID_CONFIG_KEYS.each do |key|
+       	send("#{key}=", merged_options[key])
+      end
+     
+      self.class.base_uri 'api.mtgdb.info'
+    end
+
+    #Common Functions
+    def get_rarity_types
+    	self.class.get("/cards/rarity")
+    end
+
+    def get_card_types
+    	self.class.get("/cards/types")
+    end
+
+    def get_card_subtypes
+    	self.class.get("/cards/subtypes")
+    end
+
+    #Set Functions
+    def get_sets
+    	self.class.get("/sets/")
+    end
+
+    def get_set(set_id)
+    	self.class.get("/sets/#{set_id}")
+    end
+
+    def get_random_card_in_set(set_id)
+    	self.class.get("/sets/#{set_id}/cards/random")
+    end
+
+    def get_sets_by_id(set_ids=[])
+    	self.class.get("/sets/#{set_ids.join(',').upcase}")
+    end
+
+    #Card Functions
+    def get_card(multiverse_id)
+    	self.class.get("/cards/#{multiverse_id}")
+    end
+
+    def get_cards_by_id(multiverse_ids=[])
+    	self.class.get("/cards/#{multiverse_ids.join(',')}")
+    end
+
+    def get_cards
+    	self.class.get("/cards/")
+    end
+
+    def get_random_card
+    	self.class.get("/cards/random")
+    end
+
+    def get_card_by_name(card_name)
+    	self.class.get(URI.escape("/cards/#{card_name}"))
+    end
+
+    def filter_cards(property, value)
+    	self.class.get(URI.escape("/cards/#{property}=#{value}"))
+    end
+
+    def get_card_in_set(set_id, collector_number)
+    	self.class.get(URI.escape("/sets/#{set_id}/cards/#{collector_number}"))
+    end
+
+    def search(text, start=0, limit=0, isComplex=false)
+    	if isComplex
+    		self.class.get(URI.escape("/search/?q=#{text}&start=#{start}&limit=#{limit}"))
+    	else
+    		self.class.get(URI.escape("/search/#{text}?start=#{start}&limit=#{limit}"))
+    	end
+    end
+  end
+end

data/lib/MtgDbClient/configuration.rb

@@ -0,0 +1,32 @@
+module MtgDbClient
+	module Configuration
+		VALID_CONNECTION_KEYS = [:endpoint].freeze
+		VALID_OPTION_KEYS = [:format].freeze
+		VALID_CONFIG_KEYS = VALID_CONNECTION_KEYS + VALID_OPTION_KEYS
+
+		DEFAULT_ENDPOINT = "api.mtgdb.info"
+		DEFAULT_FORMAT = :json
+
+		attr_accessor *VALID_CONFIG_KEYS
+
+		def self.extended(base)
+			base.reset
+		end
+
+		def reset
+			self.endpoint = DEFAULT_ENDPOINT
+			self.format = DEFAULT_FORMAT
+		end
+
+		def configure
+			yield self
+		end
+
+		def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+	end
+end
+
+
+

data/lib/MtgDbClient/version.rb

@@ -0,0 +1,3 @@
+module MtgDbClient
+  VERSION = "0.0.1"
+end

data/lib/MtgDbClient.rb

@@ -0,0 +1,20 @@
+require "MtgDbClient/version"
+require "MtgDbClient/configuration"
+require "MtgDbClient/client"
+
+module MtgDbClient
+	extend Configuration
+	
+	def new(options={})
+		Client.new(options)
+	end
+
+  def method_missing(method, *args, &block)
+    return super unless new.respond_to?(method)
+    new.send(method, *args, &block)
+  end
+
+  def respond_to?(method, include_private = false)
+    new.respond_to?(method, include_private) || super(method, include_private)
+  end
+end

data/test/MtgDbClient/client_test.rb

@@ -0,0 +1,161 @@
+require 'helper'
+
+describe 'client' do
+	before do
+		@keys = MtgDbClient::Configuration::VALID_CONFIG_KEYS
+	end
+
+	describe 'with module configuration' do
+		before do
+			MtgDbClient.configure do |config|
+				@keys.each do |key|
+					config.send("#{key}=", key)
+				end
+			end
+		end
+		after do
+			MtgDbClient.reset
+		end
+	it 'should inherit module configuration' do
+		mtgdb_client = MtgDbClient::Client.new
+		@keys.each do |key|
+			mtgdb_client.send(key).must_equal key
+		end
+	end
+end
+
+	it 'should be initializable' do
+		mtgdb_client = MtgDbClient::Client.new
+		mtgdb_client.wont_be_nil
+	end
+
+	it 'should have a set of configured default options' do
+		mtgdb_client = MtgDbClient::Client.new
+	end
+
+	describe '.sets' do
+		it 'should return a list of sets' do
+			mtgdb_client = MtgDbClient::Client.new
+			mtgdb_client.get_sets.wont_be_nil
+		end
+	end
+
+	describe '.rarity_types' do
+		it 'should return a list of rarities' do
+			mtgdb_client = MtgDbClient::Client.new
+			mtgdb_client.get_rarity_types.wont_be_nil
+		end
+	end
+
+	describe '.card_types' do
+		it 'should return a list of card master types' do
+			mtgdb_client = MtgDbClient::Client.new
+			mtgdb_client.get_card_types.wont_be_nil
+		end
+	end
+
+	describe '.card_subtypes' do
+		it 'should return a list of card subtypes' do
+			mtgdb_client = MtgDbClient::Client.new
+			mtgdb_client.get_card_subtypes.wont_be_nil
+		end
+	end
+
+
+	describe '.get_card(id)' do
+		it 'should return a specific card for a valid id' do
+			mtgdb_client = MtgDbClient::Client.new
+			card = mtgdb_client.get_card(386676)
+			card.wont_be_nil
+		end
+	end
+
+	describe '.random_card_in_set(set_id)' do
+		it 'should retun a random card from a specified set' do
+			mtgdb_client = MtgDbClient::Client.new
+			card = mtgdb_client.get_random_card_in_set("TMP")
+			card.wont_be_nil
+		end
+	end
+
+	describe '.sets_by_id(set_ids)' do
+		it 'should return the details of the specified sets' do
+			mtgdb_client = MtgDbClient::Client.new
+			sets = mtgdb_client.get_sets_by_id(["tmp", "sth", "exo" ])
+			sets.wont_be_nil
+		end
+	end
+
+	describe '.get_cards_by_id(multiverse_ids)' do
+		it 'should get a list of the cards with specified ids' do
+			mtgdb_client = MtgDbClient::Client.new
+			cards = mtgdb_client.get_cards_by_id([4818,4822,4823,4825,4826,4829])
+			cards.wont_be_nil
+		end
+	end
+
+	describe '.random_card' do
+		it 'should return a random card from a random set' do
+			mtgdb_client = MtgDbClient::Client.new
+			mtgdb_client.get_random_card.wont_be_nil
+		end
+	end
+
+	describe '.get_card_by_name' do
+		it 'should return all copies of a card with the same name' do
+			mtgdb_client = MtgDbClient::Client.new
+			card = mtgdb_client.get_card_by_name("Echo Chamber")
+			card.wont_be_nil
+		end
+	end
+
+	#commented due to the time it takes to run the test.
+	#describe '.get_cards' do
+	#	it 'returns all cards' do
+	#		mtgdb_client = MtgDbClient::Client.new
+	#		cards = mtgdb_client.get_cards
+	#		cards.wont_be_nil
+	#	end
+	#end
+
+	describe '.filter_cards(property, value)' do
+		it 'should return a list of cards with the specified property' do
+			mtgdb_client = MtgDbClient::Client.new
+			mtgdb_client.filter_cards("subtype", "Rat").wont_be_nil
+		end
+	end
+
+	describe '.get_card_in_set(set_id, collector_number)' do
+		it 'should return the specified card in the specified set' do
+			mtgdb_client = MtgDbClient::Client.new
+			card = mtgdb_client.get_card_in_set("tmp", 1)
+			card["name"].must_equal 'Abandon Hope'
+		end
+	end
+
+	describe '.get_set(set_id)' do
+		it 'should return the specified set' do
+			mtgdb_client = MtgDbClient::Client.new
+			set = mtgdb_client.get_set("tmp")
+			set["name"].must_equal "Tempest"
+		end
+	end
+
+	describe '.search' do
+		describe 'complex search' do
+			it 'should return all blue cloud creatures with a converted mana cost less than three' do
+				mtgdb_client = MtgDbClient::Client.new
+				results = mtgdb_client.search("color eq blue and type m 'Creature' and description m 'flying' " +
+                "and convertedmanacost lt 3 and name m 'Cloud'", 0, 0, true)
+				results.wont_be_nil
+			end
+		end
+
+		describe 'basic search' do
+			it 'should return all cards that contain the word giant' do
+				mtgdb_client = MtgDbClient::Client.new
+				mtgdb_client.search("giant").wont_be_nil
+			end
+		end
+	end
+end

data/test/MtgDbClient/configuration_test.rb

@@ -0,0 +1,11 @@
+require 'helper'
+	describe '.configure' do
+    MtgDbClient::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "should set the #{key}" do
+        MtgDbClient.configure do |config|
+          config.send("#{key}=", key)
+          MtgDbClient.send(key).must_equal key
+        end
+      end
+    end
+  end

data/test/MtgDbClient/mtgdbclient_test.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe MtgDbClient do
+	it 'should have a version' do
+		MtgDbClient::VERSION.wont_be_nil
+	end
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'MtgDbClient'
+require 'minitest/spec'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: MtgDbClient
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chase Park
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: Client gem that wraps the MtgDb Api
+email:
+- chasepark@comcast.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- MtgDbClient.gemspec
+- README.md
+- Rakefile
+- lib/MtgDbClient.rb
+- lib/MtgDbClient/client.rb
+- lib/MtgDbClient/configuration.rb
+- lib/MtgDbClient/version.rb
+- test/MtgDbClient/client_test.rb
+- test/MtgDbClient/configuration_test.rb
+- test/MtgDbClient/mtgdbclient_test.rb
+- test/helper.rb
+homepage: http://www.github.com/chasepark/MtgDbClient
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Client gem that wraps the MtgDb Api
+test_files:
+- test/MtgDbClient/client_test.rb
+- test/MtgDbClient/configuration_test.rb
+- test/MtgDbClient/mtgdbclient_test.rb
+- test/helper.rb