agilezen 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+gendoc.sh
+.yardoc/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+January 30, 2011
+================
+* Initial release of version 0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    agilezen (0.1.0)
+      faraday (~> 0.5.4)
+      faraday_middleware (~> 0.3.0)
+      hashie (~> 0.4.0)
+      multi_json (~> 0.0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.2)
+    builder (2.1.2)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    faraday (0.5.4)
+      addressable (~> 2.2.2)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    faraday_middleware (0.3.1)
+      faraday (~> 0.5.3)
+    gherkin (2.3.3)
+      json (~> 1.4.6)
+    hashie (0.4.0)
+    json (1.4.6)
+    multi_json (0.0.5)
+    multipart-post (1.1.0)
+    rack (1.2.1)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  agilezen!
+  bundler (~> 1.0)
+  cucumber (~> 0.10.0)
+  fakeweb (~> 1.3.0)
+  faraday (~> 0.5.4)
+  faraday_middleware (~> 0.3.0)
+  hashie (~> 0.4.0)
+  multi_json (~> 0.0.5)
+  rake (~> 0.8)
+  rspec (~> 2.4)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Adam McDonald
+
+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,39 @@
+# AgileZen - A Ruby wrapper for the AgileZen API (v1.0)
+
+## Installation
+
+    gem install agilezen
+
+## Usage
+
+When setting up the client, just specify your api key. Methods that are designed to take options in the API are designed that way in the wrapper also, as you'd expect. For more details, read the AgileZen API [documentation](https://agilezen.tenderapp.com/kb/api/overview).
+
+    require 'agilezen'
+    
+    # Setup the client
+    client = AgileZen::Client.new(:api_key => 'yourapikey')
+    
+    # Returns info for all your projects
+    projects = @client.projects
+    
+    # Returns info for the specified project
+    project = @client.project(123)
+    
+    # Returns info for all stories for the specified project
+    stories = @client.projects_stories(123)
+    
+    # Returns info for a specific story within a project
+    story = @client.project_story(123, 5)
+    
+    # Collection resources support pagination
+    stories = @client.projects_stories(123, :page => 2, :pageSize => 50)
+    
+    # Enrichments are supported for additional details
+    stories = @client.projects_stories(123, :with => 'details,tags')
+    
+    # Filters are supported to limit your queries
+    stories = @client.projects_stories(123, :where => 'tag:authentication')
+     
+## Documentation
+
+For additional details, checkout the latest generated [documentation](http://raid5.github.com/agilezen).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/agilezen.gemspec

@@ -0,0 +1,29 @@
+require File.expand_path("../lib/agilezen/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'agilezen'
+  s.version     = AgileZen::VERSION
+  s.authors     = ['Adam McDonald']
+  s.email       = ['mcdonald.adam@gmail.com']
+  s.homepage    = 'http://github.com/raid5/agilezen'
+  s.summary     = 'Ruby wrapper for the AgileZen API'
+  s.description = s.summary
+  
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'rake', '~> 0.8'
+  s.add_development_dependency 'rspec', '~> 2.4'
+  s.add_development_dependency 'cucumber', '~> 0.10.0'
+  s.add_development_dependency 'fakeweb', '~> 1.3.0'
+  
+  s.add_runtime_dependency 'faraday', '~> 0.5.4'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.3.0'
+  s.add_runtime_dependency 'multi_json', '~> 0.0.5'
+  s.add_runtime_dependency 'hashie', '~> 0.4.0'
+
+  s.required_rubygems_version = '>= 1.3.6'
+  s.platform                  = Gem::Platform::RUBY
+  s.rubyforge_project         = "agilezen"
+  s.require_path              = 'lib'
+  s.files                     = `git ls-files`.split("\n")
+  s.test_files                = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/agilezen.rb

@@ -0,0 +1,11 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module AgileZen
+  
+  require 'agilezen/projects'
+  require 'agilezen/stories'
+  
+  require 'agilezen/client'
+  
+end

data/lib/agilezen/client.rb

@@ -0,0 +1,55 @@
+module AgileZen
+  # AgileZen::Client class.
+  class Client
+    
+    include Projects
+    include Stories
+    
+    attr_accessor :api_key
+    attr_accessor :ssl
+    
+    # Initializer for client.
+    def initialize(options ={})
+      @api_key = options[:api_key]
+      @ssl = options[:ssl]
+    end
+    
+    # Whether the client has the require auth to make API requests.
+    def has_required_authentication?
+      !@api_key.nil?
+    end
+    
+    # Whether to use SSL or not.
+    def has_ssl?
+      @ssl
+    end
+    
+    # Set the Faraday::Connection
+    def connection=(conn)
+      @connection = conn
+    end
+    
+    # Builds and returns the Faraday::Connection based on set options.
+    def connection
+      @connection ||= Faraday::Connection.new(:url => connection_url, :headers => connection_headers) do |builder|
+        builder.adapter Faraday.default_adapter
+        #builder.use Faraday::Response::Yajl
+        builder.use Faraday::Response::ParseJson
+        builder.use Faraday::Response::Mashify
+      end
+    end
+    
+    # Helper method for determining the correct URL.
+    def connection_url
+      has_ssl? ? 'https://agilezen.com' : 'http://agilezen.com'
+    end
+    
+    # Helper method for defining globally required headers.
+    def connection_headers
+      headers = {
+        :accept => 'application/json',
+        'X-Zen-ApiKey' => @api_key
+      }
+    end
+  end
+end

data/lib/agilezen/projects.rb

@@ -0,0 +1,29 @@
+module AgileZen
+  # AgileZen::Projects module.
+  module Projects
+    
+    # Retrieve information for all projects.
+    def projects(options={})
+      response = connection.get do |req|
+        req.url "/api/v1/projects", options
+      end
+      response.body
+    end
+    
+    # Retrieve information for an individual project.
+    def project(project_id, options={})
+      response_body = nil
+      begin
+        response = connection.get do |req|
+          req.url "/api/v1/project/#{project_id}", options
+        end
+        response_body = response.body
+      rescue MultiJson::DecodeError => e
+        #p 'Unable to parse JSON.'
+      end
+      
+      response_body
+    end
+    
+  end
+end

data/lib/agilezen/stories.rb

@@ -0,0 +1,36 @@
+module AgileZen
+  # AgileZen::Stories module.
+  module Stories
+    
+    # Retrieve information for all stories of a given project.
+    def project_stories(project_id, options={})
+      response_body = nil
+      begin
+        response = connection.get do |req|
+          req.url "/api/v1/project/#{project_id}/stories", options
+        end
+        response_body = response.body
+      rescue MultiJson::DecodeError => e
+        #p 'Unable to parse JSON.'
+      end
+      
+      response_body
+    end
+    
+    # Retrieve information for an individual story of a given project.
+    def project_story(project_id, story_id, options={})
+      response_body = nil
+      begin
+        response = connection.get do |req|
+          req.url "/api/v1/project/#{project_id}/story/#{story_id}", options
+        end
+        response_body = response.body
+      rescue MultiJson::DecodeError => e
+        #p 'Unable to parse JSON.'
+      end
+      
+      response_body
+    end
+    
+  end
+end

data/lib/agilezen/version.rb

@@ -0,0 +1,4 @@
+module AgileZen
+  # Version number.
+  VERSION = '0.1.0'
+end

data/spec/client_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe AgileZen::Client do
+  
+  describe "#initialize" do
+    it "stores the api key" do
+      client = AgileZen::Client.new(:api_key => 'testapikey')
+      client.api_key.should_not be_nil
+    end
+    
+    it "ensures the ssl flag is false if not supplied" do
+      client = AgileZen::Client.new(:api_key => 'testapikey')
+      client.ssl.should be_false
+    end
+    
+    it "stores the ssl flag if supplied" do
+      client = AgileZen::Client.new(:api_key => 'testapikey', :ssl => true)
+      client.ssl.should be_true
+    end
+  end
+  
+  describe "#has_ssl?" do
+    it "checks that ssl is supported" do
+      client = AgileZen::Client.new(:api_key => 'testapikey', :ssl => true)
+      client.should have_ssl
+    end
+    
+    it "checks that ssl isn't supported" do
+      client = AgileZen::Client.new(:api_key => 'testapikey')
+      client.should_not have_ssl
+    end
+  end
+  
+  describe "#has_required_authentication?" do
+    it "checks that the api key exists" do
+      client = AgileZen::Client.new(:api_key => 'testapikey')
+      client.should have_required_authentication
+    end
+  end
+  
+  describe "#connection" do
+    context "building the Faraday::Connection" do
+      it "instantiates a Faraday::Connection" do
+        client = AgileZen::Client.new(:api_key => 'testapikey')
+        client.connection.should be_a(Faraday::Connection)
+      end
+      
+      it "configures the url" do
+        client = AgileZen::Client.new(:api_key => 'testapikey')
+        client.connection.host.should_not be_nil
+      end
+
+      it "configures any default headers" do
+        client = AgileZen::Client.new(:api_key => 'testapikey')
+        client.connection.headers.should_not be_empty
+      end
+    end
+  end
+  
+  describe "#connection_url" do
+    it "doesn't use ssl" do
+      client = AgileZen::Client.new(:api_key => 'testapikey')
+      client.connection_url.should eq('http://agilezen.com')
+    end
+    
+    it "uses ssl" do
+      client = AgileZen::Client.new(:api_key => 'testapikey', :ssl => true)
+      client.connection_url.should eq('https://agilezen.com')
+    end
+  end
+  
+  describe "#connection_headers" do
+    it "sets the Accept header to JSON" do
+      client = AgileZen::Client.new(:api_key => 'testapikey')
+      client.connection_headers.should have_key(:accept)
+      client.connection_headers.should have_value('application/json')
+    end
+    
+    it "sets the X-Zen-ApiKey header" do
+      client = AgileZen::Client.new(:api_key => 'testapikey')
+      client.connection_headers.should have_key('X-Zen-ApiKey')
+      client.connection_headers.should have_value(client.api_key)
+    end
+  end
+  
+end

data/spec/fixtures/garbage.txt

@@ -0,0 +1,27 @@
+<!doctype html>  
+<head>
+  <meta charset="utf-8">
+
+  <title></title>
+  <meta name="description" content="">
+  <meta name="author" content="">
+
+</head>
+
+<body lang="en">
+
+  <div id="container">
+    <header>
+
+    </header>
+    
+    <div id="main" role="main">
+    </div>
+    
+    <footer>
+
+    </footer>
+  </div>
+  
+</body>
+</html>

data/spec/fixtures/project.json

@@ -0,0 +1,9 @@
+{
+  "id": 123,
+  "name": "Hippie Peace",
+  "description": "Working towards world peace",
+  "owner": {
+    "id": 1,
+    "name": "John Doe"
+  }
+}

data/spec/fixtures/project/15404-with-enrichments.json

@@ -0,0 +1,86 @@
+{
+  "id": 15404,
+  "name": "Difference",
+  "description": "This is the project that makes a difference.",
+  "details": "Scope\n====\nThe scope of the project will include: 1, 2, 3, and 4. Yep, that is about it for now.",
+  "createTime": "/Date(1289217113000-0600)/",
+  "owner": {
+    "id": 19059,
+    "name": "Adam"
+  },
+  "members": [
+    {
+      "id": 19059,
+      "name": "Adam"
+    }
+  ],
+  "invites": [
+
+  ],
+  "roles": [
+    {
+      "id": 32829,
+      "name": "Administrators",
+      "members": [
+        {
+          "id": 19059,
+          "name": "Adam"
+        }
+      ]
+    },
+    {
+      "id": 32830,
+      "name": "Members",
+      "members": [
+
+      ]
+    }
+  ],
+  "phases": [
+    {
+      "id": 87565,
+      "name": "Backlog",
+      "description": "Stories that will be worked on someday",
+      "index": 0
+    },
+    {
+      "id": 87566,
+      "name": "Ready",
+      "description": "Stories that are ready to be worked on",
+      "index": 1
+    },
+    {
+      "id": 87567,
+      "name": "Development",
+      "description": "Stories that are currently being developed",
+      "index": 2
+    },
+    {
+      "id": 87570,
+      "name": "Design",
+      "description": "Stories that are currently being designed",
+      "index": 3
+    },
+    {
+      "id": 87568,
+      "name": "Complete",
+      "description": "Stories that have been completed",
+      "index": 4
+    },
+    {
+      "id": 87569,
+      "name": "Archive",
+      "description": "Stories that are history",
+      "index": 5
+    }
+  ],
+  "metrics": {
+    "throughput": 0,
+    "leadTime": 0.0,
+    "cycleTime": 0.0,
+    "workTime": 0.0,
+    "waitTime": 0.0,
+    "blockedTime": 0.0,
+    "efficiency": 0.0
+  }
+}