bikepoa-tools 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--format doc

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_install_on_use_flag=1
+rvm use --create 1.9.3@bikepoa-tools

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-19mode # JRuby in 1.9 mode

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'rspec'
+gem 'hashie'
+gem 'active_support'
+gem 'rspec'
+
+group :test do
+  gem 'fakeweb'
+  gem 'pry'
+end
+
+group :development do
+  gem 'bundler'
+  gem 'jeweler'
+  gem 'rdoc'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    hashie (1.2.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    slop (3.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  bundler
+  fakeweb
+  hashie
+  jeweler
+  pry
+  rake
+  rdoc
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Felipe Mobus
+
+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,46 @@
+[![Build Status](https://travis-ci.org/fmobus/bikepoa-tools.png)](https://travis-ci.org/fmobus/bikepoa-tools)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fmobus/bikepoa-tools)
+
+bikepoa-tools
+=============
+
+A simple API to interact with information systems of [BikePOA](http://mobilicidade.com.br/bikepoa/), the
+bicycle-sharing program of Porto Alegre, Brazil.
+
+usage
+=====
+
+```ruby
+>>> require './lib/bikepoa'
+>>> client = BikePOA::Client.new
+>>> client.stations
+[
+  <BikePOA::Station:0x007fd60191aeb8
+    @id="1", @online="A", @status="EO", @size="12", @available="6"
+    @name="Mercado", @address="Rua Marechal Floriano, 66, entre a ...">,
+  ...
+]
+>>> s.select(&:active?).map(&:to_s)
+[
+  "<Station:Mercado, 0/12>",
+  "<Station:Pra\xE7a da Alf\xE2ndega, 1/12>",
+  "<Station:Casa de Cultura Mario Quintana, 4/12>",
+  "<Station:Usina do Gas\xF4metro, 0/12>",
+  "<Station:C\xE2mara de Vereadores, 5/12>",
+  "<Station:Largo Zumbi, 3/14>",
+  "<Station:Gin\xE1sio Tesourinha, 6/12>",
+  "<Station:Shopping Praia de Belas, 3/12>",
+  "<Station:Hospital M\xE3e de Deus, 5/14>",
+  "<Station:Terminal Azenha, 3/12>",
+  "<Station:Barra Shopping, 7/14>",
+  "<Station:Escola Parob\xE9, 3/12>",
+  "<Station:Regi\xE3o dos Tribunais, 5/12>"
+]
+```
+
+todo
+====
+
+* Package it as a gem
+* Add latitude and longitude to Station
+* Less crude interface in Station

data/README.rdoc

@@ -0,0 +1,19 @@
+= bikepoa-tools
+
+Description goes here.
+
+== Contributing to bikepoa-tools
+ 
+* 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) 2012 Felipe Mobus. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bikepoa-tools"
+  gem.homepage = "http://github.com/fmobus/bikepoa-tools"
+  gem.license = "MIT"
+  gem.summary = "A simple read-only API for Porto Alegre's bike rental system, bikepoa."
+  gem.description = "A simple read-only API for Porto Alegre's bike rental system, bikepoa."
+  gem.email = "fmobus@gmail.com"
+  gem.authors = ["Felipe Mobus"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bikepoa-tools #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bikepoa-tools.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "bikepoa-tools"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Felipe Mobus"]
+  s.date = "2012-12-30"
+  s.description = "A simple read-only API for Porto Alegre's bike rental system, bikepoa."
+  s.email = "fmobus@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    ".rvmrc",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bikepoa-tools.gemspec",
+    "lib/bikepoa.rb",
+    "lib/bikepoa/client.rb",
+    "lib/bikepoa/helpers.rb",
+    "lib/bikepoa/http_client.rb",
+    "lib/bikepoa/map_parser.rb",
+    "lib/bikepoa/station.rb",
+    "spec/client_spec.rb",
+    "spec/fixtures/full_page.html",
+    "spec/helpers_spec.rb",
+    "spec/http_client_spec.rb",
+    "spec/map_parser_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/station_spec.rb"
+  ]
+  s.homepage = "http://github.com/fmobus/bikepoa-tools"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A simple read-only API for Porto Alegre's bike rental system, bikepoa."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<active_support>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<active_support>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<active_support>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

data/lib/bikepoa.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'hashie'
+require 'active_support/inflector'
+
+module BikePOA
+  def self.configure(&block)
+    yield params = Hashie::Mash.new
+    @config = params
+  end
+
+  def self.config
+    @config or {}
+  end
+
+  def self.root(*parts)
+    File.join(File.dirname(__FILE__), *parts)
+  end
+
+  %w[helpers client http_client map_parser station].each do |name|
+    autoload name.camelize.to_sym, BikePOA.root("bikepoa/#{name}")
+  end
+end

data/lib/bikepoa/client.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module BikePOA
+  class Client
+    def initialize
+      @http_client    = HttpClient.new
+      @map_parser     = MapParser.new
+    end
+
+    def stations
+      map_page = @http_client.fetch
+      @map_parser.parse(map_page).map do |station_data|
+        Station.new(station_data)
+      end
+    end
+  end
+end

data/lib/bikepoa/helpers.rb

@@ -0,0 +1,20 @@
+module BikePOA
+  module Helpers
+    module ForceField
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+        def force_integer(field)
+          class_eval do
+            define_method("#{field}=".to_sym) do |value|
+              self.[]=(field, Integer(value))
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/bikepoa/http_client.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'net/http'
+
+module BikePOA
+  DEFAULT_URI = 'http://ww2.mobilicidade.com.br/bikepoa/mapaestacao.asp'
+  class HttpClient
+    def fetch
+      location = BikePOA.config['bikepoa:uri'] || DEFAULT_URI
+      Net::HTTP.get URI(location)
+    end
+  end
+end

data/lib/bikepoa/map_parser.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'csv'
+
+module BikePOA
+  class MapParser
+    CRIAPONTO = /criaPonto\(point,(.*)\) \);/
+    def parse(content)
+      content.scan(CRIAPONTO).map do |station_match|
+        line_data = CSV.parse_line(station_match.first, quote_char: "'")
+        fields = %w[id name address _ _ _ online status size available _ _]
+        Hash[fields.zip(line_data)].delete_if { |key,value| key == '_' }
+      end
+    end
+  end
+end

data/lib/bikepoa/station.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+#
+module BikePOA
+  class Station < Hashie::Dash
+    include Helpers::ForceField
+
+    property :id
+    property :size
+    property :available
+    property :name
+    property :address
+    property :online
+    property :status
+
+    force_integer :id
+    force_integer :size
+    force_integer :available
+
+    def active?
+      self.online == 'A'
+    end
+
+    def to_s
+      "<Station##{self.id}:#{self.name}, #{self.available}/#{self.size}>"
+    end
+
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe BikePOA::Client do
+  describe 'parses latest bikepoa status' do
+    it 'extracts the status of several stations' do
+      BikePOA::HttpClient.any_instance.should_receive(:fetch).and_return('html-file')
+      BikePOA::MapParser.any_instance.should_receive(:parse).with('html-file').and_return(%w[line1 line2])
+      BikePOA::Station.should_receive(:new).with('line1').and_return('station1')
+      BikePOA::Station.should_receive(:new).with('line2').and_return('station2')
+
+      subject.stations.should include('station1','station2')
+    end
+  end
+end