eisenhower 0.0.3

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@eisenhower

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    eisenhower (0.0.1)
+      httparty (~> 0.7.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    httparty (0.7.4)
+      crack (= 0.1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  eisenhower!
+  httparty (~> 0.7.4)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r eisenhower.rb"
+end

data/eisenhower.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "eisenhower/version"
+require 'rubygems'
+
+Gem::Specification.new do |s|
+  s.name        = "eisenhower"
+  s.version     = Eisenhower::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["micah rich"]
+  s.email       = ["micah@micahrich.com"]
+  s.homepage    = "http://micahrich.com/eisenhower"
+  s.summary     = %q{A ruby wrapper for the Interstate API.}
+  s.description = %q{A ruby wrapper for the Interstate API. It's still unfinished, a bit slow, and read-only.}
+
+  s.rubyforge_project = "eisenhower"
+  s.required_rubygems_version = ">= 1.3.6"
+
+    s.add_dependency("httparty", "~> 0.7.4")
+
+
+  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/eisenhower.rb

@@ -0,0 +1,26 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'httparty'
+
+require 'eisenhower/version'
+require 'eisenhower/client'
+require 'eisenhower/roadmap'
+require 'eisenhower/road'
+require 'eisenhower/road_update'
+require 'eisenhower/staff'
+
+module Eisenhower
+  class APIError < RuntimeError; end
+  class << self
+    attr_accessor :oauth_token
+
+    def version
+      VERSION
+    end
+    
+    def history
+      "The Dwight D. Eisenhower National System of Interstate and Defense Highways, commonly called the Interstate Highway System or Interstate Freeway System, and colloquially abbreviated 'the Interstate', is a network of limited-access roadways (also called freeways or expressways) in the United States. It is named for President Dwight D. Eisenhower, who championed its formation."
+    end
+  end
+
+end

data/lib/eisenhower/client.rb

@@ -0,0 +1,22 @@
+module Eisenhower
+  class Client
+    attr_accessor :oauth_token
+    
+    include HTTParty
+    base_uri "https://api.interstateapp.com/v#{API_VERSION}"
+    format :json
+        
+    def self.fetch(path, options={})
+      options.merge!({:default_params => {:oauth_token=> Eisenhower.oauth_token}})
+      get(path, options)
+    end
+    
+    def self.get_and_parse(path, options={})
+      getter = fetch(path, options)
+      return Crack::JSON.parse(getter.body)["response"] 
+    end    
+    
+    
+    
+  end
+end

data/lib/eisenhower/road.rb

@@ -0,0 +1,46 @@
+module Eisenhower
+  class Road
+    attr_accessor :id, :title, :description, :description_html, :collapsed, :started, :status, :due, :position, :updates_count, :update_ids, :staff_ids
+    alias :name :title
+    BOOLEANS = %w(collapsed due)
+    
+    def initialize(attributes={})
+      attributes.each { |key, val| send("#{key}=", val) if respond_to?("#{key}=") }
+    end
+
+    BOOLEANS.each do |boolean|
+      define_method("#{boolean}?") do
+        self.instance_variable_get("@#{boolean}")
+      end
+    end
+    
+    def updates
+      self.update_ids.collect{|id| Eisenhower::RoadUpdate.find(id)}
+    end
+    
+    def staff
+      self.staff_ids.collect{|id| Eisenhower::Staff.find(id)}
+    end
+    
+    
+    class << self
+      def find(road_id)
+        body = Eisenhower::Client.get_and_parse("/road/get/id/#{road_id}")
+        Eisenhower::Road.new({
+          :id               => body["_id"], 
+          :title            => body["title"], 
+          :description      => body["description"], 
+          :description_html => body["descriptionHtml"], 
+          :collapsed        => body["collapsed"], 
+          :status           => body["status"]["status"], 
+          :due              => body["due"] ? body["due"]["dmy"] : false,
+          :started          => body["start"] ? body["start"]["dmy"] : false,
+          :position         => body["order"]["position"], 
+          :updates_count    => body["updatesCount"],
+          :update_ids       => body["updates"].collect{|up| up["_id"]},
+          :staff_ids        => body["staffList"]
+        })
+      end
+    end
+  end
+end

data/lib/eisenhower/road_update.rb

@@ -0,0 +1,52 @@
+module Eisenhower
+  class RoadUpdate
+    attr_accessor :id, :road_id, :staff_id, :time, :update, :road_map_id, :app_id, :staff
+    alias :user :staff
+    alias :owner :staff
+    
+    def initialize(attributes={})
+      attributes.each { |key, val| send("#{key}=", val) if respond_to?("#{key}=") }
+    end
+    
+    def staff
+      Eisenhower::Staff.find(self.staff_id)
+    end
+    
+    class << self
+      
+      def all(options={})
+        roadmap_id=nil, app_id=nil, limit=3, skip=0
+        options = {
+            :roadmap_id => nil, 
+            :app_id => nil,
+            :limit => 3,
+            :skip => 0
+            }.merge(options)
+            
+        body = Eisenhower::Client.get_and_parse("/update/listAll/roadmap/#{options[:roadmap_id]}/app/#{options[:app_id]}/limit/#{options[:limit]}/skip/#{options[:skip]}")
+        body["updates"].collect{|update| 
+          Eisenhower::RoadUpdate.new({
+            :id               => update["_id"],
+            :road_id          => update["roadId"],
+            :staff_id         => update["staffId"],
+            :time             => update["time"],
+            :update           => update["update"]
+          })}
+      end
+      
+      def find(road_update_id)
+        body = Eisenhower::Client.get_and_parse("/update/get/id/#{road_update_id}")
+        Eisenhower::RoadUpdate.new({
+          :id               => body["_id"],
+          :road_id          => body["roadId"],
+          :staff_id         => body["staffId"],
+          :time             => body["time"],
+          :update           => body["update"]
+        })
+      end
+      
+    end
+    
+    
+  end
+end

data/lib/eisenhower/roadmap.rb

@@ -0,0 +1,68 @@
+module Eisenhower
+  class Roadmap
+    attr_accessor :id, :app_id, :archived, :public, :title, :time, :staff_ids
+    alias :name :title
+    BOOLEANS = %w(archived public)
+    
+    def initialize(attributes={})
+      attributes.each { |key, val| send("#{key}=", val) if respond_to?("#{key}=") }
+    end
+
+    BOOLEANS.each do |boolean|
+      define_method("#{boolean}?") do
+        self.instance_variable_get("@#{boolean}")
+      end
+    end
+    
+    def staff
+      self.staff_ids.collect{|id| Eisenhower::Staff.find(id) }
+    end
+    
+    def roads
+      response = Eisenhower::Client.fetch("/roadmap/roads/id/#{self.id}")
+      body = Crack::JSON.parse(response.body)["response"]
+      body.collect{|road| Eisenhower::Road.new({
+        :id               => road["_id"], 
+        :title            => road["title"], 
+        :description      => road["description"], 
+        :description_html => road["descriptionHtml"], 
+        :collapsed        => road["collapsed"], 
+        :status           => road["status"]["status"], 
+        :due              => road["due"] ? road["due"]["dmy"] : false,
+        :started          => road["start"] ? road["start"]["dmy"] : false,
+        :position         => road["order"]["position"], 
+        :updates_count    => road["updatesCount"],
+        :update_ids       => road["updates"].collect{|up| up["_id"]},
+        :staff_ids        => road["staffList"]
+      })}
+    end
+    
+    class << self
+        def all
+          return body = Eisenhower::Client.get_and_parse('/roadmap/listAll')
+          #body.collect{|roadmap| Eisenhower::Roadmap.new({
+          #  :id        => roadmap.last.last["_id"], 
+          #  :app_id    => roadmap.last.last["appId"], 
+          #  :archived  => roadmap.last.last["archived"],
+          #  :public    => roadmap.last.last["public"],
+          #  :title     => roadmap.last.last["title"],
+          #  :time      => roadmap.last.last["time"],
+          #  :staff_ids => roadmap.last.last["staff"].collect{|staff| staff["_id"]}
+          #  }
+          #)}
+        end
+        
+        def find(app_id)
+          body = Eisenhower::Client.get_and_parse("/roadmap/get/id/#{app_id}")
+          Eisenhower::Roadmap.new({
+            :id        => body["_id"], 
+            :app_id    => body["appId"], 
+            :archived  => body["archived"],
+            :public    => body["public"],
+            :title     => body["title"],
+            :staff_ids => body["staff"].collect{|staff| staff["_id"]}
+          })
+        end
+    end
+  end
+end

data/lib/eisenhower/staff.rb

@@ -0,0 +1,26 @@
+module Eisenhower
+  class Staff
+    attr_accessor :id, :full_name, :email, :admin
+    alias :name :full_name
+        
+    def initialize(attributes={})
+      attributes.each { |key, val| send("#{key}=", val) if respond_to?("#{key}=") }
+    end
+    
+    def admin?
+      @admin
+    end
+    
+    class << self
+      def find(staff_id)
+        body = Eisenhower::Client.get_and_parse("/staff/get/id/#{staff_id}")
+        Eisenhower::Staff.new({
+          :id               => body["_id"],
+          :full_name        => body["fullName"],
+          :email            => body["email"],
+          :admin            => body["admin"]
+        })
+      end
+    end
+  end
+end

data/lib/eisenhower/version.rb

@@ -0,0 +1,4 @@
+module Eisenhower
+  VERSION = "0.0.3"
+  API_VERSION = 1
+end

data/readme.markdown

@@ -0,0 +1,90 @@
+<img src="https://github.com/micahbrich/eisenhower/raw/gh-pages/public/images/portrait-header.jpg" alt="Eisenhower">
+
+Eisenhower is a work-in-progress read-only rubygem to help you work the
+[Interstate API](http://developers.interstateapp.com).
+
+Install
+-------
+
+    gem install 'eisenhower'
+
+Usage
+----
+
+First thing to do is set an OAuth token – how you get this, at the moment, is up to you.
+
+    Eisenhower.oauth_token = "432n4u3h24v23"
+
+Now you can get all your roadmaps!
+
+    Eisenhower::Roadmap.all
+
+You’ll get back interconnected **Eisenhower** objects whenever possible. Try this to get all the roads on a specific roadmap:
+
+    map = Eisenhower::Roadmap.all.first 
+    map = Eisenhower::Roadmap.find("234f23f23fc2fg")
+    
+        #<Eisenhower::Roadmap:0x00000100964028 
+            @id="4d86bd5a36c040e22c000285", 
+            @app_id="4d86bd5a36c040e22c000283", 
+            @archived=false, 
+            @public=nil, 
+            @title="Your first roadmap", 
+            @staff_ids=["4d86bd5a36c040e22c000284", "4d90e61336c040672d00035e"]>
+    
+    map.roads 
+        
+        [#<Eisenhower::Road:0x000001009156d0 
+            @id="4d86bd5a36c040e22c000287", 
+            @title="This is a road", 
+            @description="A road is usually the name of a feature that you're building. Etc, etc.", 
+            @description_html="<p>A road is usually the name of a feature that you're building. Etc, etc.</p>", 
+            @collapsed=false, 
+            @status="Launched", 
+            @due=false, 
+            @started=false, 
+            @position=0, 
+            @updates_count=0, 
+            @update_ids=[], 
+            @staff_ids=["4d86bd5a36c040e22c000284"]>]
+            
+    map.roads.first.title
+    
+        "This is a road" 
+        
+    map.roads.first.staff
+    
+        [#<Eisenhower::Staff:0x000001019d9548 
+            @id="4d86bd5a36c040e22c000284", 
+            @full_name="Micah Rich", 
+            @email=nil, 
+            @admin=true>]
+            
+    And so on.
+
+
+Double check the code, but most attributes are from Interstate's documentation:
+
+1.  [Roadmaps](http://developers.interstateapp.com/roadmap/get)
+2.  [Roads](http://developers.interstateapp.com/road/get)
+3.  [Road Updates](http://developers.interstateapp.com/update/get)
+4.  [Staff](http://developers.interstateapp.com/staff/get)
+
+
+To Do
+-----
+
+There’s much left to do, so please feel free
+to fork it & help out.
+
+- **Refactor** - There are too many API calls, which makes getting simple information slow. API calls inside API calls gets ugly, and there’s a lot of information that could be instantiated without an extra call.
+
+- **Tests** - I'm a designer, and am subsequently despicable at writing tests. Please help.
+
+- **Implement newer API objects** - There are now at least two more objects (File & Activity) that I haven’t touched yet.
+
+- **Writing as well as Reading** - The only reason Eisenhower is read-only is because that’s all I’ve found time to do so far. Help here would be swell.
+
+- - -
+
+Perhaps together, we can get it up to version one.

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: eisenhower
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.3
+platform: ruby
+authors: 
+- micah rich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id001
+description: A ruby wrapper for the Interstate API. It's still unfinished, a bit slow, and read-only.
+email: 
+- micah@micahrich.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- eisenhower.gemspec
+- lib/eisenhower.rb
+- lib/eisenhower/client.rb
+- lib/eisenhower/road.rb
+- lib/eisenhower/road_update.rb
+- lib/eisenhower/roadmap.rb
+- lib/eisenhower/staff.rb
+- lib/eisenhower/version.rb
+- readme.markdown
+homepage: http://micahrich.com/eisenhower
+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: eisenhower
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the Interstate API.
+test_files: []
+