mtg_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b2702f5d06b9a76653603f369583c1963519792
+  data.tar.gz: b901c287139a30e2b7455059d91b333cea1748b3
+SHA512:
+  metadata.gz: 181f33bf30d336e2739948ddc84a593786e3dd4b0d2a35610681f84f613136c684167b4f04f103a20a113f120129ba49f80137436bd42faf5c810a6a5b19f4ef
+  data.tar.gz: 207f44f75f510c0f5309af0cbddb0d837c98767d58865efce9176e971699650b1f99b209e36a589e81ed524a8d24b33f7d4d4df9f2d8d23aa41c6e4576343f25

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/coverage/
+/doc/
+/Gemfile.lock
+/.yardoc/

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  Exclude:
+    - 'test/**/*'
+    - 'vendor/**/*'
+
+Metrics/LineLength:
+  Max: 100
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/IndentationConsistency:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+
+Style/PerlBackrefs:
+  Enabled: false
+

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kevin Deisz
+
+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,39 @@
+# MtgApi
+
+Integrate with the mtgapi.com API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mtgapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mtgapi
+
+## Usage
+
+Query cards with `MtgApi::Card` and sets with `MtgApi::Set`. Use ActiveRecord-like syntax (i.e. `MtgApi::Set.where(code: 'UNH').limit(3).first`).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/mtgapi.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MtgApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mtg_api'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/mtg_api/card.rb

@@ -0,0 +1,24 @@
+module MtgApi
+
+  # represents a card in MtG
+  class Card < RequestEntity
+
+    configure do
+      attribute :artist, :border, :cmc, :colors, :flavor, :foreign_names, :hand, :layout
+      attribute :legalities, :life, :loyalty, :mana_cost, :multiverseid, :name, :names
+      attribute :number, :original_text, :original_type, :power, :printings, :rarity
+      attribute :rulings, :set, :subtypes, :supertypes, :text, :toughness, :type, :types
+      attribute :variations, :watermark
+
+      property :images, :links
+
+      setter :border, Utilities::Border
+      setter :colors, Utilities::ColorList
+    end
+
+    # the set that this card corresponds to
+    def set
+      Set.where(code: @set).first
+    end
+  end
+end

data/lib/mtg_api/config.rb

@@ -0,0 +1,55 @@
+module MtgApi
+
+  # the configured properties of an entity
+  class Config
+
+    # the stored properties of this config
+    attr_accessor :attributes, :name, :properties, :setters
+
+    # store the class name and initialize empty lists
+    def initialize(clazz)
+      self.name = clazz.name
+      self.attributes = []
+      self.properties = []
+      self.setters = {}
+    end
+
+    # the list of attributes to build attr_accessors for
+    def accessors
+      attributes + properties - setters.keys
+    end
+
+    # add to the attributes list (queryable)
+    def attribute(*attributes)
+      self.attributes += attributes
+    end
+
+    # the endpoint to send to the api for the entity
+    def endpoint
+      @endpoint ||= '/' + response_key
+    end
+
+    # the full list of attributes set
+    def full_config
+      (attributes + properties + setters.keys).uniq
+    end
+
+    # add to the properties list (unqueryable)
+    def property(*properties)
+      self.properties += properties
+    end
+
+    # the key in the response for the api
+    def response_key
+      @response_key ||= name.downcase.split('::').last + 's'
+    end
+
+    # build a setter that can map the return value from the api
+    def setter(attribute, clazz = nil, &block)
+      setters[attribute] = proc do |value|
+        value = clazz.nil? ? block.call(value) : clazz.new(value)
+        instance_variable_set(:"@#{attribute}", value)
+      end
+    end
+  end
+end

data/lib/mtg_api/query_builder.rb

@@ -0,0 +1,75 @@
+module MtgApi
+
+  # builds queries to send to the api
+  class QueryBuilder
+
+    # the stored class and query parameters
+    attr_accessor :clazz, :stored_conditions, :stored_limit, :stored_order
+
+    extend Forwardable
+    def_delegators :all, :each, :last, :inspect
+
+    include Enumerable
+
+    # store the class and initialize an empty conditions hash
+    def initialize(clazz)
+      self.clazz = clazz
+      self.stored_conditions = {}
+    end
+
+    # builds a request object and maps the responses onto the class
+    def all
+      response = Request.new(endpoint).response_for(clazz.config.response_key)
+      response = response[0...stored_limit] unless stored_limit.nil?
+
+      response.map! do |attributes|
+        clazz.new(attributes)
+      end
+      response.sort_by!(&stored_order.to_proc) unless stored_order.nil?
+
+      response
+    end
+
+    # store the limit to the response of the query if it is valid
+    def limit(limit)
+      fail ArgumentError, "Invalid limit given: #{limit}" unless limit > 0
+
+      self.stored_limit = limit
+      self
+    end
+
+    # store the order to sort the response of the query if it is valid
+    def order(order)
+      unless clazz.attributes.include?(order)
+        fail ArgumentError, "Invalid order given: #{order}"
+      end
+
+      self.stored_order = order
+      self
+    end
+
+    # store the conditions of this query if they are valid
+    def where(conditions)
+      if (invalid = (conditions.keys - clazz.attributes)).any?
+        fail ArgumentError, "Invalid conditions given: #{invalid.join(', ')}"
+      end
+
+      stored_conditions.merge!(conditions)
+      self
+    end
+
+    private
+
+      # the configured endpoint, taking into account conditions
+      def endpoint
+        endpoint = clazz.config.endpoint.dup
+        if stored_conditions.any?
+          query_string = stored_conditions.map do |key, value|
+            URI.escape("#{key}=#{value}")
+          end
+          endpoint << '?' + query_string.join('&')
+        end
+        endpoint
+      end
+  end
+end

data/lib/mtg_api/request.rb

@@ -0,0 +1,44 @@
+module MtgApi
+
+  # builds and sends requests to the api server
+  class Request
+
+    # the root url of the api
+    ROOT_URL = 'http://api.mtgapi.com/v2'
+
+    # the url for this request
+    attr_accessor :endpoint
+
+    # build a new request
+    def initialize(endpoint)
+      self.endpoint = URI(ROOT_URL + endpoint)
+    end
+
+    # get the response
+    def response
+      puts "\e[32mGET #{endpoint}\e[0m"
+      @response ||= JSON.parse(raw_response)
+    end
+
+    # the section of the response, formatted in snake case
+    def response_for(response_key)
+      (response[response_key] || []).map do |entity|
+        rubyify(entity)
+      end
+    end
+
+    private
+
+      # the response from the server
+      def raw_response
+        Net::HTTP.get(endpoint)
+      end
+
+      # format a hash to have snake case keys
+      def rubyify(entity)
+        entity.map do |key, value|
+          [key.to_s.gsub(/([A-Z])/) { '_' + $1.downcase }, value]
+        end.to_h
+      end
+  end
+end

data/lib/mtg_api/request_entity.rb

@@ -0,0 +1,47 @@
+module MtgApi
+
+  # represents an entity being returned from the API
+  class RequestEntity
+
+    # build a card set from a set of attributes
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        send(:"#{key}=", value) if respond_to?(:"#{key}=")
+      end
+    end
+
+    # the attributes of this request entity
+    def attributes
+      self.class.config.full_config.map { |attribute| [attribute, send(attribute)] }.to_h
+    end
+
+    class << self
+      # the stored Config instance for this class
+      attr_accessor :config
+
+      extend Forwardable
+      def_delegators :config, :attributes, :properties
+      def_delegators :query_builder, :all, :limit, :where, :first, :last, :order
+
+      # build a config and evaluate the block inside of it
+      def configure(&block)
+        self.config = Config.new(self)
+        config.instance_eval(&block)
+
+        attr_accessor *config.accessors
+        attr_reader *config.setters.keys
+
+        config.setters.each do |name, definition|
+          define_method(:"#{name}=", definition)
+        end
+      end
+
+      private
+
+        # build a query builder whenever query methods are called on this class
+        def query_builder
+          QueryBuilder.new(self)
+        end
+    end
+  end
+end

data/lib/mtg_api/set.rb

@@ -0,0 +1,27 @@
+module MtgApi
+
+  # represents a set in MtG
+  class Set < RequestEntity
+
+    configure do
+      attribute :block, :border, :code, :gatherer_code, :name
+      attribute :old_code, :online_only, :release_date, :type
+
+      property :card_count, :links, :symbol_images
+
+      setter :border, Utilities::Border
+      setter :links do |links|
+        Utilities::SetLinks.new(links.map { |key, value| [key.to_sym, value] }.to_h)
+      end
+      setter :release_date do |date|
+        Date.parse(date) if date
+      end
+      setter :type, Utilities::SetType
+    end
+
+    # the cards that belong to this set
+    def cards
+      Card.where(set: code)
+    end
+  end
+end

data/lib/mtg_api/utilities/border.rb

@@ -0,0 +1,11 @@
+module MtgApi
+  module Utilities
+
+    # stores the border of a card or set
+    class Border < WhiteList
+
+      self.list = %w[white black silver]
+
+    end
+  end
+end

data/lib/mtg_api/utilities/color_list.rb

@@ -0,0 +1,11 @@
+module MtgApi
+  module Utilities
+
+    # stores the list of colors on a card
+    class ColorList < WhiteList
+
+      self.list = ['white', 'blue', 'green', 'red', 'black', nil]
+
+    end
+  end
+end

data/lib/mtg_api/utilities/set_links.rb

@@ -0,0 +1,17 @@
+module MtgApi
+  module Utilities
+
+    # stores the links to the cards or booster of a set
+    class SetLinks
+
+      # the urls
+      attr_accessor :cards, :booster
+
+      # store the given values
+      def initialize(args = {})
+        self.cards = args[:cards]
+        self.booster = args[:booster]
+      end
+    end
+  end
+end

data/lib/mtg_api/utilities/set_type.rb

@@ -0,0 +1,13 @@
+module MtgApi
+  module Utilities
+
+    # stores the type of a set
+    class SetType < WhiteList
+
+      self.list = ['archenemy', 'box', 'commander', 'conspiracy', 'core', 'duel deck',
+                   'expansion', 'from the vault', 'masters', 'planechase', 'premium deck',
+                   'promo', 'reprint', 'starter', 'un', 'vanguard']
+
+    end
+  end
+end

data/lib/mtg_api/utilities/white_list.rb

@@ -0,0 +1,34 @@
+module MtgApi
+  module Utilities
+
+    # a class that validates that the initialization value is
+    # contained in the list stored on the class
+    class WhiteList
+
+      # the value of this instance of a whitelist
+      attr_accessor :value
+
+      # store and validate the given value
+      def initialize(value)
+        self.value = value
+        fail ArgumentError, "Invalid value given: #{value.inspect}" unless valid?
+      end
+
+      class << self
+        # the list of available values
+        attr_accessor :list
+      end
+
+      private
+
+        # whether or not the given value is valid
+        def valid?
+          if value.is_a?(Array)
+            (value - self.class.list).none?
+          else
+            self.class.list.include?(value)
+          end
+        end
+    end
+  end
+end

data/lib/mtg_api/utilities.rb

@@ -0,0 +1,12 @@
+require 'mtg_api/utilities/white_list'
+require 'mtg_api/utilities/border'
+require 'mtg_api/utilities/color_list'
+require 'mtg_api/utilities/set_type'
+require 'mtg_api/utilities/set_links'
+
+module MtgApi
+
+  # builds structures for attributes of entities
+  module Utilities
+  end
+end

data/lib/mtg_api/version.rb

@@ -0,0 +1,5 @@
+module MtgApi
+
+  # the current version of this gem
+  VERSION = '0.0.1'
+end

data/lib/mtg_api.rb

@@ -0,0 +1,16 @@
+require 'forwardable'
+require 'json'
+require 'net/http'
+
+require 'mtg_api/config'
+require 'mtg_api/request'
+require 'mtg_api/request_entity'
+require 'mtg_api/query_builder'
+require 'mtg_api/utilities'
+
+require 'mtg_api/card'
+require 'mtg_api/set'
+
+# namespace for the MtgApi gem
+module MtgApi
+end

data/mtg_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mtg_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mtg_api'
+  spec.version       = MtgApi::VERSION
+  spec.authors       = ['Kevin Deisz']
+  spec.email         = ['kevin.deisz@gmail.com']
+  spec.homepage      = 'https://github.com/kddeisz/mtg_api'
+
+  spec.summary       = 'Ruby integration with mtgapi.com'
+  spec.description   = 'Query for cards, sets, and boosters against the mtgapi.com API'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'rubocop', '~> 0.33'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: mtg_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Deisz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Query for cards, sets, and boosters against the mtgapi.com API
+email:
+- kevin.deisz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mtg_api.rb
+- lib/mtg_api/card.rb
+- lib/mtg_api/config.rb
+- lib/mtg_api/query_builder.rb
+- lib/mtg_api/request.rb
+- lib/mtg_api/request_entity.rb
+- lib/mtg_api/set.rb
+- lib/mtg_api/utilities.rb
+- lib/mtg_api/utilities/border.rb
+- lib/mtg_api/utilities/color_list.rb
+- lib/mtg_api/utilities/set_links.rb
+- lib/mtg_api/utilities/set_type.rb
+- lib/mtg_api/utilities/white_list.rb
+- lib/mtg_api/version.rb
+- mtg_api.gemspec
+homepage: https://github.com/kddeisz/mtg_api
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby integration with mtgapi.com
+test_files: []
+has_rdoc: