devinci 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+coverage
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Paul Guelpa
+
+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.rdoc

@@ -0,0 +1,19 @@
+= devinci
+
+Parses the data files supplied by a number of bike share systems
+
+== Contributing to devinci
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Paul Guelpa. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov_opts = ['--exclude', 'gems']
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/devinci.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devinci/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devinci"
+  s.version     = Devinci::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Guelpa"]
+  s.email       = ["paul.guelpa@gmail.com"]
+  s.homepage    = "http://github.com/pguelpa/devinci"
+  s.summary     = %q{Parser for various bike share data files}
+  s.description = %q{Parses the data files supplied by a number of bike share systems}
+
+  s.rubyforge_project = "devinci"
+
+  s.add_dependency "libxml-ruby", ">= 1.1.3"
+  s.add_dependency "nokogiri", ">= 1.5.0"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rake", ">= 0.9.0"
+  s.add_development_dependency "rcov", ">= 0.9.10"
+  s.add_development_dependency "rspec", ">= 2.3.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/devinci.rb

@@ -0,0 +1,5 @@
+require 'libxml'
+require 'nokogiri'
+
+require 'devinci/base'
+require 'devinci/bixi'

data/lib/devinci/base.rb

@@ -0,0 +1,33 @@
+module Devinci
+  class ParseError < RuntimeError; end
+
+  class Base
+    attr_reader :filename, :options
+
+    def initialize(filename, options = {})
+      @filename = filename
+      @options = options
+    end
+
+    def io
+      @io ||= case @options[:compression]
+      when :gzip
+        Zlib::GzipReader.open(@filename)
+      else
+        File.open(@filename)
+      end
+    end
+
+    def downloaded_on
+      match = filename.match(/(\d{4})-(\d{2})-(\d{2})..(\d{2}):(\d{2}):(\d{2})/)
+      if match
+        numbers = (1..6).map { |n| match[n].to_i }
+        Time.utc(*numbers)
+      end
+    end
+
+    def parse
+      raise NotImplementedError, "Each parser must define their own parse method"
+    end
+  end
+end

data/lib/devinci/bixi.rb

@@ -0,0 +1,52 @@
+module Devinci
+  class Bixi < Base
+    attr_reader :document
+
+    def parse
+      @document = Nokogiri::XML(io)
+
+      @document.xpath('/stations/station').map do |node|
+        parse_station(node)
+      end
+    rescue Exception => e
+      raise Devinci::ParseError, "Error parsing the input from XML: #{e.message}", e.backtrace
+    ensure
+      io.close
+    end
+
+    private
+      def parse_station(node)
+        station = {}
+        node.children.each do |c|
+          case c.name
+          when 'id'
+            station[:id] = c.content
+          when 'name'
+            station[:name] = c.content
+          when 'terminalName'
+            station[:terminal_name] = c.content
+          when 'lat'
+            station[:latitude] = c.content.to_f
+          when 'long'
+            station[:longitude] = c.content.to_f
+          when 'installed'
+            station[:installed] = (c.content == 'true')
+          when 'locked'
+            station[:locked] = (c.content == 'true')
+          when 'installDate'
+            station[:installed_on] = c.content.empty? ? nil : Time.at(c.content.to_i / 1000)
+          when 'removalDate'
+            station[:removed_on] = c.content.empty? ? nil : Time.at(c.content.to_i / 1000)
+          when 'temporary'
+            station[:temporary] = (c.content == 'true')
+          when 'nbBikes'
+            station[:bikes] = c.content.to_i
+          when 'nbEmptyDocks'
+            station[:empty_docks] = c.content.to_i
+          end
+        end
+
+        station
+      end
+  end
+end

data/lib/devinci/version.rb

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

data/spec/devinci/base_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Devinci::Base do
+  describe ".new" do
+    it "should take a filename" do
+      filename = "/root/fooname"
+      Devinci::Base.new(filename).filename.should == filename
+    end
+  end
+
+  describe "#io" do
+    it "should return a regular file object when there is no compression" do
+      File.should_receive(:open).with('/root/fooname').and_return(:file_io)
+      Devinci::Base.new('/root/fooname').io.should == :file_io
+    end
+
+    it "should memoize the io object for later use" do
+      file = mock(File)
+      File.should_receive(:open).once.and_return(file)
+
+      parser = Devinci::Base.new(anything)
+      2.times { parser.io }
+    end
+
+    it "should build an Gzip IO object when :compression => :gzip" do
+      Zlib::GzipReader.should_receive(:open).with('/root/fooname').and_return(:gzip_file_io)
+      Devinci::Base.new('/root/fooname', :compression => :gzip).io.should == :gzip_file_io
+    end
+  end
+
+  describe "#downloaded_on" do
+    it "should parse the time that the data was downloaded on from the filename as UTC" do
+      at = Devinci::Base.new('someStation-2011-05-14::14:00:01.xml.gz').downloaded_on
+      at.should == Time.utc(2011, 5, 14, 14, 0, 1)
+    end
+  end
+
+  describe "#parse" do
+    it "should raise a NotImplementedError" do
+      lambda {
+        Devinci::Base.new(anything).parse
+      }.should raise_error NotImplementedError
+    end
+  end
+end

data/spec/devinci/bixi_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Devinci::Bixi do
+  describe "#parse" do
+    before do
+      @io = mock(IO, :close => nil)
+      @document = mock(Nokogiri::XML::Document, :xpath => [])
+
+      @parser = Devinci::Bixi.new(anything)
+      @parser.stub!(:io).and_return(@io)
+    end
+
+    it "should use the inherited io method and pass the result to Nokogiri" do
+      Nokogiri.should_receive(:XML).with(@io).and_return(@document)
+      @parser.parse
+    end
+
+    it "should search for all the stations" do
+      Nokogiri.stub!(:XML).and_return(@document)
+      @document.should_receive(:xpath).with('/stations/station').and_return([])
+
+      @parser.parse
+    end
+
+    it "should close the io object after successful parsing" do
+      Nokogiri.stub!(:XML).and_return(@document)
+
+      @io.should_receive(:close)
+      @parser.parse
+    end
+
+    it "should close the io object after failed parsing" do
+      Nokogiri.stub!(:XML).and_raise
+
+      @io.should_receive(:close)
+      lambda { @parser.parse }.should raise_error
+    end
+
+    it "should raise a ParseError if the file fails to be parsed" do
+      Nokogiri.stub!(:XML).and_raise ArgumentError.new("Foo Error")
+
+      lambda {
+        @parser.parse
+      }.should raise_error Devinci::ParseError, /Foo Error/
+    end
+  end
+
+  describe "#parse (station details)" do
+    before :all do
+      @station = Devinci::Bixi.new('spec/fixtures/devinci/bixi_station.xml').parse.first
+    end
+
+    {
+      :id => '1',
+      :name => 'Notre Dame / Place Jacques Cartier',
+      :terminal_name => '6001',
+      :latitude => 45.508183,
+      :longitude => -73.554094,
+      :installed => true,
+      :locked => false,
+      :installed_on => Time.utc(2010, 6, 8, 16, 02, 00),
+      :removed_on => Time.utc(2010, 7, 9, 16, 02, 00),
+      :temporary => false,
+      :bikes => 13,
+      :empty_docks => 17,
+    }.each do |attribute, value|
+      it "should parse #{attribute} from the node" do
+        @station[attribute].should == value
+      end
+    end
+  end
+
+  describe "#parse (missing dates)" do
+    before :all do
+      @station = Devinci::Bixi.new('spec/fixtures/devinci/bixi_station_no_dates.xml').parse.first
+    end
+
+    it "should return nil for install_date if it has no value" do
+      @station[:installed_on].should be_nil
+    end
+
+    it "should return nil for removed_on if it has no value" do
+      @station[:removed_on].should be_nil
+    end
+  end
+end

data/spec/fixtures/devinci/bixi_station.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<stations lastUpdate="1305354525205" version="2.0">
+  <station>
+    <id>1</id>
+    <name>Notre Dame / Place Jacques Cartier</name>
+    <terminalName>6001</terminalName>
+    <lat>45.508183</lat>
+    <long>-73.554094</long>
+    <installed>true</installed>
+    <locked>false</locked>
+    <installDate>1276012920000</installDate>
+    <removalDate>1278691320000</removalDate>
+    <temporary>false</temporary>
+    <nbBikes>13</nbBikes>
+    <nbEmptyDocks>17</nbEmptyDocks>
+  </station>
+</stations>

data/spec/fixtures/devinci/bixi_station_no_dates.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<stations>
+  <station>
+    <id>1</id>
+    <name>Notre Dame / Place Jacques Cartier</name>
+    <terminalName>6001</terminalName>
+    <lat>45.508183</lat>
+    <long>-73.554094</long>
+    <installed>true</installed>
+    <locked>false</locked>
+    <installDate/>
+    <removalDate/>
+    <temporary>false</temporary>
+    <nbBikes>13</nbBikes>
+    <nbEmptyDocks>17</nbEmptyDocks>
+  </station>
+</stations>

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'devinci'

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification 
+name: devinci
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Guelpa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  name: libxml-ruby
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 1
+        - 3
+        version: 1.1.3
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  name: nokogiri
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  prerelease: false
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rake
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  prerelease: false
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 0
+        - 9
+        - 10
+        version: 0.9.10
+  prerelease: false
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rspec
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  requirement: *id006
+description: Parses the data files supplied by a number of bike share systems
+email: 
+- paul.guelpa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- devinci.gemspec
+- lib/devinci.rb
+- lib/devinci/base.rb
+- lib/devinci/bixi.rb
+- lib/devinci/version.rb
+- spec/devinci/base_spec.rb
+- spec/devinci/bixi_spec.rb
+- spec/fixtures/devinci/bixi_station.xml
+- spec/fixtures/devinci/bixi_station_no_dates.xml
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/pguelpa/devinci
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: devinci
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Parser for various bike share data files
+test_files: 
+- spec/devinci/base_spec.rb
+- spec/devinci/bixi_spec.rb
+- spec/fixtures/devinci/bixi_station.xml
+- spec/fixtures/devinci/bixi_station_no_dates.xml
+- spec/spec_helper.rb