scapeshift 1.0.1rg0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,36 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## IntelliJ
+.idea
+*.iml
+.rakeTasks
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## YARD
+doc/*
+.yardoc
+
+## BUNDLER
+.bundle/*
+
+## PROJECT::SPECIFIC
+
+## FAKEWEB CACHE FILES
+test/fakeweb/*.html

data/.yardopts

@@ -0,0 +1 @@
+--protected --private --default-return 'void'

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+gem 'bundler'
+
+# Development dependencies
+gem 'rake'
+gem 'jeweler'
+gem 'rdoc'
+gem 'yard'
+gem 'bluecloth'
+gem 'shoulda'
+
+# Test dependencies
+gem 'fakeweb'
+
+# Runtime dependencies
+gem 'nokogiri'
+

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.1.0)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rdoc (3.8)
+    shoulda (2.11.3)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth
+  bundler
+  fakeweb
+  jeweler
+  nokogiri
+  rake
+  rdoc
+  shoulda
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Josh Lindsey
+
+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,76 @@
+Scapeshift
+==========
+
+Scapeshift is a webscraper rubygem designed for the Magic: The Gathering Oracle "Gatherer" card index.
+Since Wizards doesn't want to make an API for this system for various reasons, I've gone ahead and made
+a pseudo-API here.
+
+Scapeshift uses the delightful Nokogiri gem to parse and scrape the various Oracle pages, generating 
+(most commonly) a SortedSet of Scapeshift::Card objects containing the card data. In the case of expansion sets, formats, 
+etc. Scapeshift returns a SortedSet of strings.
+
+Usage
+-----
+
+Usage is as simple as can be:
+
+    # Grab the complete list of expansion sets
+    @sets = Scapeshift::Crawler.crawl :meta, :type => :sets
+
+    # Grab the card set for an expansion
+    @alara_cards = Scapeshift::Crawler.crawl :cards, :set => 'Shards of Alara'
+
+    # Grab a single named card
+    @card = Scapeshift::Crawler.crawl :single, :name => 'Counterspell'
+
+Development
+-----------
+
+This gem uses Bundler to manage its dependencies for development:
+
+    $ sudo gem install bundler
+    $ cd /path/to/scapeshift
+    $ bundle install
+
+Bundler is unlike Rubygems in that it doesn't automagically handle load paths for you. To
+make stuff work, you will need to start a subshell with
+    
+    $ bundle exec bash
+
+Replacing `bash` with the shell of your choice, of course.
+
+Testing
+-------
+
+This gem's tests use fakeweb to mock HTTP connections and speed things up. To run the tests you must first run:
+
+    rake fakeweb:update
+
+This will download the content of the urls needed in tests (and specified in `test/fakeweb.urls`) and store them in
+local files for quick access.
+
+Then to run the tests just run
+
+    rake
+
+If you write a test that opens up a new URL the test will automatically fail because FakeWeb is configured to not allow
+actual HTTP connections to open and the new URL is not configured for the cache. To do this just add the new URL in the
+`test/fakeweb.urls` file and update the caches with `rake fakeweb:update`.
+
+Documentation
+-------------
+
+This gem uses Yardoc syntax for documentation. You can generate these docs
+with `rake yard`. Point any webserver at the `docs/` directory to browse.
+
+Simple, with Thin:
+
+    $ cd /path/to/scapeshift
+    $ rake yard
+    $ cd docs/
+    $ thin -A file -d start
+
+Copyright
+---------
+
+Copyright (c) 2010 Josh Lindsey. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "scapeshift"
+    gem.summary = %Q{Magic: The Gathering Oracle web scraper}
+    gem.description = %Q{Powers the Scapeshift web API.}
+    gem.email = "joshua.s.lindsey@gmail.com"
+    gem.homepage = "http://github.com/jlindsey/scapeshift"
+    gem.authors = ["Josh Lindsey"]
+    gem.add_development_dependency "bundler"
+    gem.add_dependency "nokogiri"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+desc "Remove docs generated by yard"
+task :clobber_yard do
+  puts "rm -rf doc/"
+  %x{rm -rf doc/}
+end
+
+desc "Searches for all @todo tags and prints them"
+task :todos do
+  puts %x{grep -inr "@todo" lib/}
+end
+
+namespace :fakeweb do
+  task :update do
+    require 'test/fakeweb_helper'
+    FakeWebHelper.cache_all_urls
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/lib/scapeshift.rb

@@ -0,0 +1,9 @@
+require 'scapeshift/crawler'
+
+##
+# A webscraper gem designed for the Magic: The Gathering
+# Oracle "Gatherer" card index.
+#
+# @author Josh Lindsey
+#
+module Scapeshift; end

data/lib/scapeshift/card.rb

@@ -0,0 +1,404 @@
+# encoding: utf-8
+module Scapeshift
+
+  ##
+  # Represents a single Magic: The Gathering card. These are created automatically
+  # by the various {Crawlers}, but can be instantiated by end-users if they desire.
+  #
+  # @author Josh Lindsey
+  #
+  # @since 0.1.0
+  #
+  class Card
+
+    ##
+    # Base URI for card images. Interpolated with the "multiverse id" of the
+    # card to be imaged.
+    Image_URI = 'http://gatherer.wizards.com/Handlers/Image.ashx?multiverseid=%d&type=card'
+
+    ##
+    # List of possible Supertypes a Card can have
+    Supertypes = %w(Basic Legendary Snow World)
+
+    ##
+    # List of possible Base Types a Card can have
+    Base_Types = %w(Artifact Creature Enchantment Land Planeswalker Instant Sorcery Tribal Plane Vanguard)
+
+    ## @return [String] The card's name
+    attr_accessor :name
+
+    ## @return [String] The card's multiverse id (ie its id on the Gatherer website)
+    attr_accessor :multiverse_id
+
+    ## @return [String] The mana cost of the card, in the form "2BR"
+    attr_accessor :cost
+
+    ## @return [Array] An array of the card's base types
+    attr_accessor :base_types
+
+    ## @return [Array] An array of the card's subtypes.
+    attr_accessor :subtypes
+
+    ## @return [Array] An array of the card's supertypes.
+    attr_accessor :supertypes
+
+    ## @return [String] Attack power for creature cards
+    attr_accessor :pow
+
+    ## @return [String] Toughness for creature cards
+    attr_accessor :tgh
+
+    ## @return [String] The card's body text
+    attr_accessor :text
+
+    ## @return [String] The card's flavour text
+    attr_accessor :flavour_text
+
+    ## @return [Array [[Set, Rarity]]] The sets and rarities of this card. 
+    attr_accessor :sets
+
+    ## @return [String] The interpolated Image_URI string
+    attr_accessor :image_uri
+
+    ## @return [String] The loyalty for planeswalker cards
+    attr_accessor :loyalty
+
+    ## @return [String] The card's artist name
+    attr_accessor :artist
+
+    ## @return [String] The card's number
+    attr_accessor :number
+    
+    ##
+    # Converts a mana word into its representative cost symbol.
+    #
+    # @example Blue
+    #   Scapeshift::Card.cost_symbol_from_str "Blue"  # => "U"
+    # 
+    # @example 3 Colorless
+    #   Scapeshift::Card.cost_symbol_from_str "3"     # => "3"
+    #
+    # @param [String] str The String representation of the cost symbol
+    #
+    # @return [String] The symbol representing the mana cost
+    #
+    # @raise [Scapeshift::Errors::UnknownCostSymbol] If an urecognized word is supplied.
+    #   (eg. "Purple")
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.2.0
+    #
+    def self.cost_symbol_from_str str
+      case str
+      # If the input is simply a number, it's already a valid cost symbol.
+      when /[\d]+/
+        str
+      # The Chaos Planechase symbol. I don't actually know
+      # what the proper textual representation of this is.
+      when '[chaos]'
+        str
+      # "Variable Colorless" is the word representation of X costs.
+      when 'Variable Colorless'
+        'X'
+      # Normal colors
+      when 'White'
+        'W'
+      when 'Red'
+        'R'
+      when 'Blue'
+        'U'
+      when 'Black'
+        'B'
+      when 'Green'
+        'G'
+      # Two or colors
+      when 'Two or White'
+        '(2/W)'
+      when 'Two or Red'
+        '(2/R)'
+      when 'Two or Blue'
+        '(2/U)'
+      when 'Two or Black'
+        '(2/B)'
+      when 'Two or Green'
+        '(2/G)'
+      # Phyrexian colors
+      when 'Phyrexian White'
+        '(W/P)'
+      when 'Phyrexian Red'
+        '(R/P)'
+      when 'Phyrexian Blue'
+        '(U/P)'
+      when 'Phyrexian Black'
+        '(B/P)'
+      when 'Phyrexian Green'
+        '(G/P)'
+      # Dual Colors
+      when 'Black or Red'
+        '(B/R)'
+      when 'Black or Green'
+        '(B/G)'
+      when 'Red or Green'
+        '(R/G)'
+      when 'Red or White'
+        '(R/W)'
+      when 'Green or White'
+        '(G/W)'
+      when 'Green or Blue'
+        '(G/U)'
+      when 'White or Blue'
+        '(W/U)'
+      when 'White or Black'
+        '(W/B)'
+      when 'Blue or Black'
+        '(U/B)'
+      when 'Blue or Red'
+        '(U/R)'
+      # Snow
+      when 'Snow'
+        'S}i'
+      # Tap
+      when 'Tap'
+        'T'
+      # Untap
+      when 'Untap'
+        'Q'
+      else
+        raise Scapeshift::Errors::UnknownCostSymbol.new "Unrecognized cost '#{str}'"
+      end
+    end
+
+    ##
+    # Instantiate a new Card object.
+    #
+    # @param [Hash] params Default values for the object.
+    #   Similar to ActiveRecord::Base.
+    #
+    # @return [Card] The new Card object
+    #
+    # @raise [NoMethodError] If a key is passed in for which there is no corresponding
+    #   setter method.
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.0
+    #
+    def initialize params = {}
+      self.supertypes = []
+      self.subtypes = []
+      self.base_types = []
+      self.sets = [[]]
+
+      return if params.empty?
+
+      params.each_pair do |var, val| 
+        method = (var.to_s + "=").to_sym
+        self.send method, val
+      end
+    end
+
+    ##
+    # Interpolates the Image_URI with the "multiverse id".
+    #
+    # @param [Integer] id The "multiverse id" for this card
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.0
+    #
+    def image_uri_from_id= id
+      self.image_uri = Image_URI % id
+    end
+
+    ## To make Hash instantiation more readable
+    alias :image_id= :image_uri_from_id=
+
+    ##
+    # Sets the Card's {#subtypes}, {#supertypes}, and {#base_types}
+    # from a correctly formatted String.
+    #
+    # @param [String] types_str The types string
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.3
+    #
+    def types= types_str
+      ary = [[], []]
+
+      # From the Cards crawler
+      if types_str.include? ' — ' 
+        ary = _split_base_and_subtypes types_str, ' — '
+      # Also from the Cards crawler: ' – '
+      elsif types_str.include? " \342\200\223 "
+        ary = _split_base_and_subtypes types_str, " \342\200\223 "
+      # Also from the Cards crawler: ' — '
+      elsif types_str.include? " \342\200\224 "
+        ary = _split_base_and_subtypes types_str, " \342\200\224 "
+
+      # Other possible dashes
+      # Not seen them on gatherer yet but including them for completion's sake
+      elsif types_str.include? " \357\271\230 "
+        ary = _split_base_and_subtypes types_str, " \357\271\230 "
+      elsif types_str.include? " \357\271\243 "
+        ary = _split_base_and_subtypes types_str, " \357\271\243 "
+      elsif types_str.include? " \357\274\215 "
+        ary = _split_base_and_subtypes types_str, " \357\274\215 "
+
+      # From manual text input.
+      # Note that this is a hyphen. Above is a dash (Alt + - in OS X).
+      elsif types_str.include? ' - '
+        ary = _split_base_and_subtypes types_str, ' - '
+
+      # If it doesn't contain one of these delimiters, it has no subtypes
+      else
+        ary[0] = types_str.split(' ')
+      end
+      
+      self.supertypes = ary[0] & Supertypes
+      self.base_types = ary[0] & Base_Types
+      self.subtypes = ary[1]
+    end
+
+    ##
+    # The types of this card in string form.
+    #
+    # @return [String] The formatted Type string.
+    #   Should be a valid input for {#types=}
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.3
+    #
+    def types
+      type = ''
+      unless self.supertypes.empty?
+        type << self.supertypes.join(' ')
+        type << ' '
+      end
+
+      type << self.base_types.join(' ')
+
+      unless self.subtypes.empty?
+        type << ' - '
+        type << self.subtypes.join(' ')
+      end
+
+      type
+    end
+
+    ##
+    # The most recent rarity of this card.
+    #
+    # @return [String] The rarity.
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.0
+    #
+    def rarity
+      self.sets.first[1]
+    end
+
+    ##
+    # The most recent set this card appeared in.
+    #
+    # @return [String] The set.
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.0
+    #
+    def set
+      self.sets.first[0]
+    end
+
+    ##
+    # Set the power and toughness from an Array.
+    #
+    # @param [Array [Power, Toughness]] pt The power and toughness array
+    # 
+    # @author Josh Lindsey
+    #
+    # @since 0.1.0
+    #
+    def pow_tgh=(pt)
+      return if pt.nil?
+      self.pow = pt[0]
+      self.tgh = pt[1]
+    end
+
+    ##
+    # Operator method to determine sort order. Sorts based
+    # on {#name}.
+    #
+    # @param [Card] other_card The other Card to compare with
+    #
+    # @return [Integer] 1, 0, or -1
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.2
+    #
+    def <=> other_card
+      self.name <=> other_card.name
+    end
+
+    ##
+    # Operator method to determine equality. Does an `==` comparison
+    # on each attribute of the Card objects. All must be equal
+    # for true.
+    #
+    # @param [Card] other_card The other Card to compare with
+    #
+    # @return [Boolean] Whether or not they are equal
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.2
+    #
+    def == other_card
+      if self.name == other_card.name and
+        self.cost == other_card.cost and
+        self.sets == other_card.sets and
+        self.image_uri == other_card.image_uri and
+        self.multiverse_id == other_card.multiverse_id and
+        self.text == other_card.text and
+        self.flavour_text == other_card.flavour_text and
+        self.types == other_card.types and
+        self.loyalty == other_card.loyalty and
+        self.artist == other_card.artist and
+        self.number == other_card.number
+
+        return true
+      end
+
+      return false
+    end
+
+    private
+
+    ##
+    # Used by {#types=} to split the types line string into an array
+    # of types and subtypes.
+    #
+    # @param [String] types_str The correctly formatted types line string
+    # @param [String] split_on The string that delimits super/base types and subtypes
+    #
+    # @return [Array] First element is the base (and possibly super) types.
+    #   Second element is the subtypes.
+    #
+    # @author Josh Lindsey
+    #
+    # @since 0.1.3
+    #
+    def _split_base_and_subtypes types_str, split_on
+      ary = types_str.split(split_on)
+      ary[0] = ary[0].split(' ')
+      ary[1] = ary[1].split(' ')
+      ary
+    end
+  end
+end
+