sifter 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+html

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+gemspec
+
+group :development, :test do
+  gem 'rspec', '~> 2.5.0'
+  gem 'fakeweb', '~> 1.3.0'
+end

data/README.md

@@ -0,0 +1,47 @@
+# sifter-ruby
+
+It's an API wrapper for the [Sifter API](http://sifterapp.com/developer). You
+can use it to fetch projects, issues, milestones, and people from your Sifter
+accounts.
+
+## Getting started
+
+First you'll need to generate a Sifter API token. You can do this in your
+Sifter account by going to "My Profile", clicking "Access Keys" and filling out
+form. Once you've got that, you create an account object like so:
+
+    hostname = "example.sifterapp.com"
+    token = "abc123"
+    account = Sifter::Account.new(hostname, token)
+
+All of the functionality in the Sifter API hangs off `Sifter::Account`. You can
+fetch projects, issues, and milestones like so:
+
+    projects = account.projects 
+    issues = projects.first.issues
+    milestones = projects.first.milestones
+
+## License
+
+    The MIT License
+
+    Copyright (c) 2011 Next Update
+
+    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/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["--format documentation"]
+end
+
+Rake::RDocTask.new do |t|
+  t.main = "README.md"
+  t.rdoc_files.include("README.md", "lib/**/*.rb")
+  t.options << "--accessor=property"
+end

data/examples/listing.rb

@@ -0,0 +1,52 @@
+require "sifter"
+require "optparse"
+
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+    Usage:
+      milestones -t <token> -a <account> -p <project> [-m <name>]
+
+    Options:
+  EOF
+
+  opts.on("-tTOKEN", "--token TOKEN", "Sifter API token") do |t|
+    options[:token] = t
+  end
+
+  opts.on("-aACCOUNT", "--account ACCOUNT", "Account/subdomain to query") do |a|
+    options[:account] = a
+  end
+
+  opts.on("-mMILESTONE", "--milestone MILESTONE", "Milestone to query") do |m|
+    options[:milestone] = m
+  end
+
+  opts.on("-pPROJECT", "--project PROJECT", "Project to query") do |p|
+    options[:project] = p
+  end
+end
+
+opts.parse!
+
+if __FILE__ == $PROGRAM_NAME
+  unless options.has_key?(:account) && options.has_key?(:token)
+    puts "Account and token parameters required."
+    exit 1
+  end
+
+  hostname = "#{options[:account]}.sifterapp.com"
+  token = options[:token]
+  account = Sifter::Account.new(hostname, token)
+  if options.has_key?(:project)
+    project = account.projects.select { |p|
+      p.name.downcase == options[:project].downcase
+    }.first
+
+    puts "Milestones:"
+    project.milestones.each { |m| puts "  #{m.name}" }
+  else
+    puts "Projects:"
+    account.projects.each { |p| puts "  #{p.name}" }
+  end
+end

data/lib/sifter.rb

@@ -0,0 +1,50 @@
+require "httparty"
+require "hashie"
+
+class Sifter
+
+  include HTTParty
+
+  autoload :Account, "sifter/account"
+  autoload :Project, "sifter/project"
+
+  # Wrapper around an issue.
+  class Issue < Hashie::Dash
+
+    property :number
+    property :subject
+    property :description
+    property :priority
+    property :status
+    property :assignee_name
+    property :category_name
+    property :milestone_name
+    property :opener_name
+    property :url
+    property :api_url
+    
+  end
+
+  # Wrapper around a milestone.
+  class Milestone < Hashie::Dash
+    
+    property :name
+    property :due_date
+    property :url
+    property :api_url
+    property :issues_url
+    property :api_issues_url
+    
+  end
+
+  # Wrapper around a person.
+  class Person < Hashie::Dash
+    
+    property :username
+    property :first_name
+    property :last_name
+    property :email
+    
+  end
+
+end

data/lib/sifter/account.rb

@@ -0,0 +1,40 @@
+# Wrapper around an a Sifter account. Use this as the root for accessing the
+# Sifter API.
+class Sifter::Account
+
+  # Connect to a Sifter account. The host is the subdomain for your Sifter
+  # account (yourhost.sifterapp.com), you can get a token by going to
+  # Profile->Access Keys.
+  def initialize(host, token)
+    Sifter.default_options[:base_uri] = "https://" << host
+    Sifter.default_options[:headers] = {"X-Sifter-Token" => token}
+  end
+
+  # Fetch the possible issue statuses for this project. This is currently hardcoded
+  # in the app, so it's unlikely they'll change anytime soon.
+  def statuses
+    Sifter.
+      get("/api/statuses").
+      parsed_response["statuses"]
+  end
+
+
+  # Fetch the possible issue priorities for this project. This is currently hardcoded
+  # in the app, so it's unlikely they'll change anytime soon.
+  def priorities
+    Sifter.
+      get("/api/priorities").
+      parsed_response["priorities"]
+  end
+
+  # Fetch all projects that you have access to for this account. Returns an
+  # array of Sifter::Project objects.
+  def projects
+    Sifter.
+      get("/api/projects").
+      parsed_response["projects"].
+      map { |p| Sifter::Project.new(p) }
+  end
+
+end
+

data/lib/sifter/project.rb

@@ -0,0 +1,44 @@
+# Wrapper for a Sifter project. Fetch projects using Sifter::Account.
+class Sifter::Project < Hashie::Dash
+
+  property :name
+  property :archived
+  property :primary_company_name
+  property :url
+  property :api_url
+  property :issues_url
+  property :milestones_url
+  property :people_url
+  property :api_milestones_url
+  property :api_people_url
+  property :api_issues_url
+  property :api_categories_url
+
+  # Fetch all the issues on this project. Returns an array of Sifter::Issue
+  # objects.
+  def issues
+    Sifter.
+      get(api_issues_url).
+      fetch("issues", []).
+      map { |i| Sifter::Issue.new(i) }
+  end
+
+  # Fetch all the milestones for this project. Returns an array of
+  # Sifter::Milestone objects.
+  def milestones
+    Sifter.
+      get(api_milestones_url).
+      fetch("milestones", []).
+      map { |m| Sifter::Milestone.new(m) }
+  end
+
+  # Fetch all the people linked to this project. Returns an array of
+  # Sifter::Person objects.
+  def people
+    Sifter.
+      get(api_people_url).
+      fetch("people", []).
+      map { |p| Sifter::Person.new(p) }
+  end
+
+end

data/lib/sifter/version.rb

@@ -0,0 +1,3 @@
+class Sifter
+  VERSION = "0.1.0"
+end

data/sifter.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sifter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sifter"
+  s.version     = Sifter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Adam Keys"]
+  s.email       = ["adam@nextupdate.com"]
+  s.homepage    = "http://github.com/nextupdate/sifter-ruby"
+  s.summary     = %q{Wrapper for the Sifter API}
+  s.description = %q{Query, fetch, create and modify issues stored in Sifter.}
+
+  s.rubyforge_project = "sifter"
+
+  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"]
+
+  s.add_dependency 'httparty', '~> 0.6.1'
+  s.add_dependency 'hashie', '~> 0.4.0'
+end

data/spec/fixtures/issues.json

@@ -0,0 +1,36 @@
+{
+  "issues": [
+    {
+      "number": 57,
+      "category_name": "Enhancement",
+      "priority": "Trivial",
+      "subject": "Donec vel neque",
+      "description": "Nam id libero quis ipsum feugiat elementum. Vivamus vitae mauris ut ipsum mattis malesuada. Sed vel massa. Mauris lobortis. Nunc egestas, massa id scelerisque dapibus, urna mi accumsan purus, vel aliquam nunc sapien eget nisi. Quisque vitae nibh. Proin interdum mollis leo. Fusce sed nisi. Integer ut tortor.",
+      "milestone_name": null,
+      "opener_name": "Adam Keys",
+      "assignee_name": "Garrett Dimon",
+      "status": "Open",
+      "url": "https://example.sifterapp.com/projects/189113590/issues/46809840",
+      "api_url": "https://example.sifterapp.com/api/projects/189113590/issues/46809840"
+    },
+    {
+      "number": 63,
+      "category_name": "Bug",
+      "priority": "Trivial",
+      "subject": "Sed lectus nunc, egestas tincidunt",
+      "description": "Proin dictum dignissim metus. Vivamus vel risus sed augue venenatis sodales. Quisque tempus dictum lorem. Sed a turpis eu turpis lobortis pellentesque. Nunc sem mi, ullamcorper non, dignissim eu, pellentesque eget, justo. Donec mollis neque quis tortor. In hac habitasse platea dictumst. Mauris at velit non erat scelerisque iaculis.",
+      "milestone_name": null,
+      "opener_name": "Adam Keys",
+      "assignee_name": null,
+      "status": "Open",
+      "url": "https://example.sifterapp.com/projects/189113590/issues/465769292",
+      "api_url": "https://example.sifterapp.com/api/projects/189113590/issues/465769292"
+    }
+  ],
+  "per_page": 10,
+  "page": 1,
+  "total_pages": 2,
+  "next_page_url": "https://example.sifterapp.com/api/projects/189113590/issues?per_page=10&page=1",
+  "previous_page_url": null
+}
+

data/spec/fixtures/milestones.json

@@ -0,0 +1,18 @@
+{
+  "milestones": [
+    {
+      "name": "Private Release",
+      "due_date": "2010/04/15",
+      "issues_url": "https://example.sifterapp.com/projects/189113590/issues?m=1",
+      "api_issues_url": "https://example.sifterapp.com/api/projects/189113590/issues?m=1"
+    },
+    {
+      "name": "Public Release",
+      "due_date": "2010/05/15",
+      "issues_url": "https://example.sifterapp.com/projects/189113590/issues?m=2",
+      "api_issues_url": "https://example.sifterapp.com/api/projects/189113590/issues?m=2"
+    }
+
+  ]
+}
+

data/spec/fixtures/people.json

@@ -0,0 +1,22 @@
+{
+  "people": [
+   {
+      "username": "gdimon",
+      "first_name": "Garrett",
+      "last_name": "Dimon",
+      "email": "garrett@nextupdate.com"
+    },
+    {
+      "username": "lpage",
+      "first_name": "Larry",
+      "last_name": "Page",
+      "email": "larry@garrettdimon.com"
+    },
+    {
+      "username": "sbrin",
+      "first_name": "Sergey",
+      "last_name": "Brin",
+      "email": "sergey@garrettdimon.com"
+    }
+  ]
+}

data/spec/fixtures/priorities.json

@@ -0,0 +1,9 @@
+{
+  "priorities": {
+    "Trivial": 5,
+    "High": 2,
+    "Normal": 3,
+    "Critical": 1,
+    "Low": 4
+  }
+}

data/spec/fixtures/projects.json

@@ -0,0 +1,31 @@
+{
+  "projects": [
+    {
+      "name": "Elephant",
+      "primary_company_name": "Apple",
+      "archived": false,
+      "url": "https://example.sifterapp.com/projects/189113590",
+      "issues_url": "https://example.sifterapp.com/projects/189113590/issues",
+      "milestones_url": "https://example.sifterapp.com/projects/189113590/milestones",
+      "api_url": "https://example.sifterapp.com/api/projects/189113590",
+      "api_issues_url": "https://example.sifterapp.com/api/projects/189113590/issues",
+      "api_milestones_url": "https://example.sifterapp.com/api/projects/189113590/milestones",
+      "api_categories_url": "https://example.sifterapp.com/api/projects/189113590/categories",
+      "api_people_url": "https://example.sifterapp.com/api/projects/189113590/people"
+    },
+    {
+      "name": "Zebra",
+      "primary_company_name": "Google",
+      "archived": true,
+      "url": "https://example.sifterapp.com/projects/358047158",
+      "issues_url": "https://example.sifterapp.com/projects/358047158/issues",
+      "milestones_url": "https://example.sifterapp.com/projects/358047158/milestones",
+      "api_url": "https://example.sifterapp.com/api/projects/358047158",
+      "api_issues_url": "https://example.sifterapp.com/api/projects/358047158/issues",
+      "api_milestones_url": "https://example.sifterapp.com/api/projects/358047158/milestones",
+      "api_categories_url": "https://example.sifterapp.com/api/projects/358047158/categories",
+      "api_people_url": "https://example.sifterapp.com/api/projects/358047158/people"
+    }
+  ]
+}
+

data/spec/fixtures/statuses.json

@@ -0,0 +1,9 @@
+{
+  "statuses": {
+    "Open": 1,
+    "Closed": 4,
+    "Resolved": 3,
+    "Reopened": 2
+  }
+}
+

data/spec/sifter/account_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Sifter::Account do
+
+  let(:account) { Sifter::Account.new("example.sifterapp.com", "abc123") }
+
+  it "fetches status codes" do
+    stub_get("/api/statuses", "statuses.json")
+
+    statuses = account.statuses
+
+    statuses["Open"].should == 1
+    statuses.length.should == 4
+  end
+
+  it "fetches priority codes" do
+    stub_get("/api/priorities", "priorities.json")
+
+    priorities = account.priorities
+
+    priorities["High"].should == 2
+    priorities.length.should == 5
+  end
+  
+  it "fetches all projects" do
+    stub_get("/api/projects", "projects.json")
+
+    projects = account.projects
+
+    projects.length.should == 2
+    projects.first.should be_kind_of(Sifter::Project)
+  end
+
+end

data/spec/sifter/project_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Sifter::Project do
+
+  before do
+    stub_get("/api/projects", "projects.json")
+  end
+
+  let(:account) { Sifter::Account.new("example.sifterapp.com", "abc123") }
+  let(:project) { account.projects.select { |p| p.name == "Elephant" }.first }
+
+  it "initializes from a hash" do
+    attrs = {
+      "name"=>"Elephant",
+      "issues_url"=>"https://example.sifterapp.com/projects/189113590/issues",
+      "api_milestones_url"=>
+      "https://example.sifterapp.com/api/projects/189113590/milestones",
+      "primary_company_name"=>"Apple",
+      "api_people_url"=>
+      "https://example.sifterapp.com/api/projects/189113590/people",
+      "url"=>"https://example.sifterapp.com/projects/189113590",
+      "archived"=>false,
+      "api_issues_url"=>
+      "https://example.sifterapp.com/api/projects/189113590/issues",
+      "api_categories_url"=>
+      "https://example.sifterapp.com/api/projects/189113590/categories",
+      "api_url"=>"https://example.sifterapp.com/api/projects/189113590",
+      "milestones_url"=>
+      "https://example.sifterapp.com/projects/189113590/milestones"
+    }
+
+    project = Sifter::Project.new(attrs)
+    attrs.each { |k, v| project[k].should == v }
+  end
+
+  it "fetches issues" do
+    stub_get(project.api_issues_url, "issues.json")
+
+    issues = project.issues
+
+    issues.length.should == 2
+    issues.first.should be_a(Sifter::Issue)
+  end
+
+  it "fetches milestones" do
+    stub_get(project.api_milestones_url, "milestones.json")
+
+    milestones = project.milestones
+
+    milestones.length.should == 2
+    milestones.first.should be_a(Sifter::Milestone)
+  end
+
+  it "fetches people" do
+    stub_get(project.api_people_url, "people.json")
+
+    people = project.people
+
+    people.length.should == 3
+    people.first.should be_a(Sifter::Person)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require "fakeweb"
+require "sifter"
+
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do
+
+  # Gratuitously borrowed from Wynn Netherland's gowalla gem
+  def stub_get(url, filename, options={})
+    opts = {
+      :body => fixture_file(filename),
+      :content_type => 'application/json; charset=utf-8'
+    }.merge(options)
+    FakeWeb.register_uri(:get, sifter_url(url), opts)
+  end
+
+  def fixture_file(filename)
+    return filename if filename == ''
+    file_path = File.expand_path(
+      File.dirname(__FILE__) + '/fixtures/' + filename
+    )
+    File.read(file_path)
+  end
+
+  def sifter_url(url)
+    url =~ /^http/ ? url : "https://example.sifterapp.com#{url}"
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: sifter
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Keys
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-10 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id002
+description: Query, fetch, create and modify issues stored in Sifter.
+email: 
+- adam@nextupdate.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- examples/listing.rb
+- lib/sifter.rb
+- lib/sifter/account.rb
+- lib/sifter/project.rb
+- lib/sifter/version.rb
+- sifter.gemspec
+- spec/fixtures/issues.json
+- spec/fixtures/milestones.json
+- spec/fixtures/people.json
+- spec/fixtures/priorities.json
+- spec/fixtures/projects.json
+- spec/fixtures/statuses.json
+- spec/sifter/account_spec.rb
+- spec/sifter/project_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nextupdate/sifter-ruby
+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: sifter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper for the Sifter API
+test_files: 
+- spec/fixtures/issues.json
+- spec/fixtures/milestones.json
+- spec/fixtures/people.json
+- spec/fixtures/priorities.json
+- spec/fixtures/projects.json
+- spec/fixtures/statuses.json
+- spec/sifter/account_spec.rb
+- spec/sifter/project_spec.rb
+- spec/spec_helper.rb