gatherer 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jonan Scheffler
+
+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,25 @@
+    _.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,
+
+      .,-:::::/   :::. :::::::::::: ::   .: .,:::::: :::::::..  .,:::::: :::::::..   
+    ,;;-'````'    ;;`;;;;;;;;;;'''',;;   ;;,;;;;'''' ;;;;``;;;; ;;;;'''' ;;;;``;;;;  
+    [[[   [[[[[[/,[[ '[[,   [[    ,[[[,,,[[[ [[cccc   [[[,/[[['  [[cccc   [[[,/[[['  
+    "$$c.    "$$c$$$cc$$$c  $$    "$$$"""$$$ $$""""   $$$$$$c    $$""""   $$$$$$c    
+     `Y8bo,,,o88o888   888, 88,    888   "88o888oo,__ 888b "88bo,888oo,__ 888b "88bo,
+       `'YMUP"YMMYMM   ""`  MMM    MMM    YMM""""YUMMMMMMM   "W" """"YUMMMMMMM   "W" 
+
+    `'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`'~,_.~'`
+
+
+# Gatherer: The Magicking
+
+Gatherer is a gem to scrape Magic: The Gathering card data from [gatherer.wizards.com](http://gatherer.wizards.com).
+
+To grab a card you'll need the Multiverse ID; these IDs uniquely identify cards within gatherer.
+
+    client = Gatherer::Client.new
+    client.fetch_by_multiverse_id(111)
+
+The fetch will give you a complete Gatherer::Card with any data that could be scraped from gatherer.
+If you use a non-existent Multiverse ID you will get a Gatherer::CardNotFound error.
+
+If you have any questions or you'd like this gem to do something else feel free to contact me.

data/lib/gatherer/card.rb

@@ -0,0 +1,82 @@
+require 'open-uri'
+require 'nokogiri'
+require 'gatherer/card_parser'
+
+module Gatherer
+  class Card
+    COLOR_SYMBOLS = {
+      "Variable Colorless" => "X",
+      "White" => "W",
+      "Blue" => "U",
+      "Black" => "B",
+      "Red" => "R",
+      "Green" => "G",
+      "White or Blue" => "(W/U)",
+      "White or Black" => "(W/B)",
+      "White or Red" => "(W/R)",
+      "White or Green" => "(W/G)",
+      "Blue or White" => "(U/W)",
+      "Blue or Black" => "(U/B)",
+      "Blue or Red" => "(U/R)",
+      "Blue or Green" => "(U/G)",
+      "Black or White" => "(B/W)",
+      "Black or Blue" => "(B/U)",
+      "Black or Green" => "(B/G)",
+      "Black or Red" => "(B/R)",
+      "Red or White" => "(R/W)",
+      "Red or Blue" => "(R/U)",
+      "Red or Black" => "(R/B)",
+      "Red or Green" => "(R/G)",
+      "Green or White" => "(G/W)",
+      "Green or Blue" => "(G/U)",
+      "Green or Black" => "(G/B)",
+      "Green or Red" => "(G/R)"
+    }
+
+    attr_reader :title,
+                :types,
+                :mana_cost,
+                :converted_mana_cost,
+                :subtypes,
+                :text,
+                :flavor_text,
+                :printings,
+                :power,
+                :toughness,
+                :loyalty,
+                :illustrator
+
+    def initialize(attributes = {})
+      @title = attributes[:title]
+      @types = attributes[:types]
+      @mana_cost = attributes[:mana_cost]
+      @converted_mana_cost = attributes[:converted_mana_cost]
+      @subtypes = attributes[:subtypes]
+      @text = attributes[:text]
+      @flavor_text = attributes[:flavor_text]
+      @printings = attributes[:printings]
+      @power = attributes[:power]
+      @toughness = attributes[:toughness]
+      @loyalty = attributes[:loyalty]
+      @illustrator = attributes[:illustrator]
+    end
+
+    def self.new_from_parser(parser)
+      new(
+        title: parser.title,
+        types: parser.types,
+        mana_cost: parser.mana_cost,
+        converted_mana_cost: parser.converted_mana_cost,
+        subtypes: parser.subtypes,
+        text: parser.text,
+        flavor_text: parser.flavor_text,
+        printings: parser.printings,
+        power: parser.power,
+        toughness: parser.toughness,
+        loyalty: parser.loyalty,
+        number: parser.number,
+        illustrator: parser.illustrator
+      )
+    end
+  end
+end

data/lib/gatherer/card_parser.rb

@@ -0,0 +1,230 @@
+module Gatherer
+  class CardParser
+    attr_reader :document
+
+    SELECTORS = {
+      title: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_nameRow',
+      types: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_typeRow',
+      cmc: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_cmcRow',
+      mana: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_manaRow',
+      subtypes: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_typeRow',
+      text: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_textRow',
+      flavor_text: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_flavorRow',
+      set: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_setRow',
+      other_sets: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_otherSetsRow',
+      pt: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_ptRow',
+      number: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_numberRow',
+      illustrator: 'div#ctl00_ctl00_ctl00_MainContent_SubContent_SubContent_artistRow'
+    }
+
+    def initialize(html, validate_card_markup = true)
+      @document = Nokogiri::HTML(html)
+      validate if validate_card_markup
+    end
+
+    def validate
+      raise CardNotFound if document.css(SELECTORS[:illustrator]).empty?
+    end
+
+    def title(parsed_text = extract_title)
+      parsed_text.strip
+    end
+
+    def extract_title
+      row = document.css(SELECTORS[:title])
+      title_line = row.css('div.value').text
+    end
+
+    def types(parsed_text = extract_types)
+      [parsed_text.strip.split("\u2014").first.split].flatten
+    end
+
+    def extract_types
+      row = document.css(SELECTORS[:types])
+      type_line = row.css('div.value').text
+    end
+
+    def converted_mana_cost(parsed_text = extract_converted_mana_cost)
+      parsed_text.strip.to_i
+    end
+
+    def extract_converted_mana_cost
+      row = document.css(SELECTORS[:cmc])
+      cmc_line = row.css('div.value').text
+    end
+
+    def mana_cost(parsed_text = extract_mana_cost)
+      color_map = Gatherer::Card::COLOR_SYMBOLS
+      parsed_text.map { |mana| color_map[mana] ? color_map[mana] : mana }.join
+    end
+
+    def extract_mana_cost
+      row = document.css(SELECTORS[:mana])
+      mana_cost_line = row.css('div.value').css('img').map { |img| img['alt'] }
+    end
+
+    def subtypes(parsed_text = extract_subtypes)
+      if parsed_text.include?("\u2014")
+        parsed_text.split("\u2014").last.split(' ').map { |type| type.strip }
+      else
+        []
+      end
+    end
+
+    def extract_subtypes
+      row = document.css(SELECTORS[:subtypes])
+      row.css('div.value').text
+    end
+
+    def text(parsed_text = extract_text)
+      parsed_text.map { |line| line.strip }.compact.join("\n")
+    end
+
+    def extract_text
+      row = document.css(SELECTORS[:text]).first
+      row.inner_html = replace_mana_symbols(row.inner_html)
+      row.css('div.value div.cardtextbox').map(&:text)
+    end
+
+    def replace_mana_symbols(html)
+      while image = html.match(/<img.*?alt="([^"]*)"[^>]*>/)
+        html.gsub!(image.to_s, "{{#{image.captures.first}}}")
+      end
+
+      html
+    end
+
+    def flavor_text(parsed_text = extract_flavor_text)
+      parsed_text.strip
+    end
+
+    def extract_flavor_text
+      row = document.css(SELECTORS[:flavor_text])
+      row.css('div.cardtextbox').text
+    end
+
+    def parse_printing(printing)
+      title = printing.split(' (').first
+      Printing.new(
+        expansion: Expansion.new(title: title, abbreviation: abbreviation(title)),
+        rarity: printing.split(' (').last.chop,
+        number: (number if current_printing?(title))
+      )
+    end
+
+    def printings(parsed_text = extract_printings)
+      parsed_text.map do |printing|
+        parse_printing(printing)
+      end
+    end
+
+    def extract_printings
+      ([extract_current_printing] + extract_other_printings).uniq
+    end
+
+    def current_printing(parsed_text = extract_current_printing)
+      parse_printing(parsed_text)
+    end
+
+    def current_printing?(title)
+      current_printing_text = extract_current_printing
+      current_title = current_printing_text.split(' (').first if current_printing_text
+      title == current_title
+    end
+
+    def extract_current_printing
+      row = document.css(SELECTORS[:set])
+      row.css('img').map { |img| img['title'] }.first
+    end
+
+    def other_printings(parsed_text = extract_other_printings)
+      parsed_text.map do |printing|
+        Printing.new(
+          expansion: Expansion.new(:title => parsed_text.split(' (').first),
+          rarity: parsed_text.split(' (').last.chop
+        )
+      end
+    end
+
+    def extract_other_printings
+      row = document.css(SELECTORS[:other_sets])
+      row.css('img').map { |img| img['title'] }
+    end
+
+    def abbreviation(title, parsed_text = nil)
+      parsed_text ||= extract_abbreviation(title)
+      parsed_text.split('&set=').last.split('&').first if parsed_text
+    end
+
+    def extract_abbreviation(title)
+      images = document.css(SELECTORS[:set]).css('img')
+      images += document.css(SELECTORS[:other_sets]).css('img')
+
+      images.map do |image|
+        image['src'] if image['title'].include?(title)
+      end.compact.uniq.first
+    end
+
+    def power(parsed_text = extract_power_toughness)
+      parsed_text.split('/').first if parsed_text.include?('/')
+    end
+
+    def toughness(parsed_text = extract_power_toughness)
+      parsed_text.split('/').last if parsed_text.include?('/')
+    end
+
+    def extract_power_toughness
+      row = document.css(SELECTORS[:pt])
+      row.css('div.value').text
+    end
+
+    # gatherer uses the pt row to display loyalty
+    def loyalty(parsed_text = extract_power_toughness)
+      unless parsed_text.include?('/')
+        parsed_text.to_i if parsed_text.to_i > 0
+      end
+    end
+
+    def number(parsed_text = extract_number)
+      parsed_text.to_i
+    end
+
+    def extract_number
+      row = document.css(SELECTORS[:number])
+      row.css('div.value').text
+    end
+
+    def illustrator(parsed_text = extract_illustrator)
+      parsed_text.strip
+    end
+
+    def extract_illustrator
+      row = document.css(SELECTORS[:illustrator])
+      row.css('div.value').text
+    end
+
+    def to_hash
+      {
+        title: title,
+        types: types,
+        mana_cost: mana_cost,
+        converted_mana_cost: converted_mana_cost,
+        subtypes: subtypes,
+        text: text,
+        flavor_text: flavor_text,
+        printings: printings.map(&:to_hash),
+        power: power,
+        toughness: toughness,
+        loyalty: loyalty,
+        number: number,
+        illustrator: illustrator
+      }
+    end
+  end
+
+  class CardNotFound < StandardError
+    def initialize
+      super("Could not find card.")
+    end
+  end
+end

data/lib/gatherer/client.rb

@@ -0,0 +1,24 @@
+require 'open-uri'
+require 'gatherer/scraper'
+require 'gatherer/card_parser'
+
+module Gatherer
+  class Client
+    def fetch_by_multiverse_id(id)
+      card_from(scraper(id))
+    end
+
+    def scraper(id)
+      Gatherer::Scraper.new(multiverse_id: id)
+    end
+
+    def page_from(scraper)
+      open(scraper.url)
+    end
+
+    def card_from(scraper)
+      parser = Gatherer::CardParser.new(page_from(scraper))
+      Card.new_from_parser(parser)
+    end
+  end
+end

data/lib/gatherer/expansion.rb

@@ -0,0 +1,17 @@
+module Gatherer
+  class Expansion
+    attr_reader :title, :abbreviation
+
+    def initialize(attributes)
+      @title = attributes[:title]
+      @abbreviation = attributes[:abbreviation]
+    end
+
+    def to_hash
+      {
+        title: @title,
+        abbreviation: @abbreviation
+      }
+    end
+  end
+end

data/lib/gatherer/printing.rb

@@ -0,0 +1,19 @@
+module Gatherer
+  class Printing
+    attr_reader :expansion, :rarity, :number
+
+    def initialize(attributes)
+      @expansion = attributes[:expansion]
+      @rarity = attributes[:rarity]
+      @number = attributes[:number]
+    end
+
+    def to_hash
+      {
+        expansion: @expansion.to_hash,
+        rarity: @rarity,
+        number: @number
+      }
+    end
+  end
+end

data/lib/gatherer/scraper.rb

@@ -0,0 +1,35 @@
+module Gatherer
+  class Scraper
+    BASE_PATH = "http://gatherer.wizards.com"
+
+    def initialize(params = {})
+      @query = ''
+      @subpath = ''
+
+      options = params.map do |k,v|
+        send(k, v)
+      end
+
+      if options
+        @query = URI.encode(options.join('&'))
+      end
+    end
+
+    def url
+      BASE_PATH + @subpath + (@query.empty? ? '' : '?' + @query)
+    end
+
+    def set(name)
+      "set=[#{name}]"
+    end
+
+    def page(number)
+      "page=#{number}"
+    end
+
+    def multiverse_id(id)
+      @subpath = "/Pages/Card/Details.aspx"
+      "multiverseid=#{id}"
+    end
+  end
+end

data/lib/gatherer/version.rb

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

data/lib/gatherer.rb

@@ -0,0 +1,6 @@
+require "gatherer/scraper"
+require "gatherer/card"
+require 'gatherer/card_parser'
+require 'gatherer/printing'
+require 'gatherer/expansion'
+require 'gatherer/client'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: gatherer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonan Scheffler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+description: ! 'Gatherer is a gem to scrape Magic: The Gathering cards.'
+email:
+- jonanscheffler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gatherer/card.rb
+- lib/gatherer/card_parser.rb
+- lib/gatherer/client.rb
+- lib/gatherer/expansion.rb
+- lib/gatherer/printing.rb
+- lib/gatherer/scraper.rb
+- lib/gatherer/version.rb
+- lib/gatherer.rb
+- LICENSE
+- CHANGELOG.md
+- README.md
+homepage: http://github.com/1337807/gatherer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! 'Gatherer: The Magicking'
+test_files: []