octopussy 0.2.3 → 0.2.4

data/lib/octopussy.rb

@@ -13,6 +13,8 @@ require 'octopussy/client'
 
 module Octopussy
   extend SingleForwardable
+  
+  VERSION = "0.2.4".freeze
 
   class OctopussyError < StandardError
     attr_reader :data
@@ -54,4 +56,7 @@ module Octopussy
   
   # Commits
   def_delegators :client, :list_commits, :commit
+  
+  # Timeline
+  def_delegators :client, :public_timeline
 end

data/lib/octopussy/client.rb

@@ -9,8 +9,15 @@ module Octopussy
     
     # :login => 'pengwynn', :token => 'your_github_api_key'
     def initialize(auth={})
-      @login = auth[:login]
-      @token = auth[:token]
+      if auth[:password].nil?
+        @login = auth[:login]
+        @token = auth[:token]
+        self.class.basic_auth(nil, nil)
+      else
+        @login = auth[:login]
+        self.class.basic_auth(@login, auth[:password])
+      end
+      
     end
     
     def search_users(q)
@@ -345,10 +352,26 @@ module Octopussy
       Hashie::Mash.new(response).commit
     end
     
+    def public_timeline(username = nil)
+      username ||= @login
+      if username.nil?
+        path = "http://github.com/timeline.json"
+      else 
+        path = "http://github.com/#{username}.json"
+      end
+      response = self.class.get(path)
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+    
+    def timeline
+      response = self.class.get("http://github.com/#{@login}.private.json", :query => auth_params)
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+    
     private
     
     def auth_params
-      @login.nil? ? {} : {:login => @login, :token => @token}
+      @token.nil? ? {} : {:login => @login, :token => @token}
     end
 
     def self.get(*args); handle_response super end

data/test/octopussy_test.rb

@@ -6,6 +6,14 @@ class OctopussyTest < Test::Unit::TestCase
     setup do
       @client = Octopussy::Client.new(:login => 'pengwynn', :token => 'OU812')
     end
+    
+    should "authenticate via basic auth" do
+      stub_get("http://pengwynn:OU812@github.com/api/v2/json/user/show/pengwynn", "full_user.json")
+      client = Octopussy::Client.new(:login => 'pengwynn', :password => 'OU812')
+      user = client.user
+      user.plan.name.should == 'free'
+      user.plan.space.should == 307200
+    end
 
     should "should search users" do
       stub_get("/user/search/wynn", "search.json")
@@ -237,7 +245,19 @@ class OctopussyTest < Test::Unit::TestCase
       collaborators.last.should == 'adamstac'
     end
 
-
+    should "fetch a user's public timeline" do
+      stub_get("http://github.com/pengwynn.json", "timeline.json")
+      events = @client.public_timeline('pengwynn')
+      events.first['type'].should == 'FollowEvent'
+      events[1].repository.name.should == 'octopussy'
+    end
+    
+    should "fetch a user's private timeline" do
+      stub_get("http://github.com/pengwynn.private.json?login=pengwynn&token=OU812", "timeline.json")
+      events = @client.timeline
+      events.first['type'].should == 'FollowEvent'
+      events[1].repository.name.should == 'octopussy'
+    end
   end
 
 
@@ -393,7 +413,7 @@ class OctopussyTest < Test::Unit::TestCase
     end
 
     should "return the contents of a blob with the blob's SHA" do
-      stub_get("http://github.com/api/v2/yaml/blob/show/defunkt/facebox/4bf7a39e8c4ec54f8b4cd594a3616d69004aba69", "raw_git_data.json")
+      stub_get("http://github.com/api/v2/yaml/blob/show/defunkt/facebox/4bf7a39e8c4ec54f8b4cd594a3616d69004aba69", "raw_git_data.yaml")
       raw_text = Octopussy.raw({:username => "defunkt", :repo => "facebox"}, "4bf7a39e8c4ec54f8b4cd594a3616d69004aba69")
       assert raw_text.include?("cd13d9a61288dceb0a7aa73b55ed2fd019f4f1f7")
     end
@@ -417,6 +437,22 @@ class OctopussyTest < Test::Unit::TestCase
       show_commit = Octopussy.commit({:username => "defunkt", :repo => "facebox"}, sha)
       assert show_commit.message == "Fixed CSS expression, throwing errors in IE6."
     end
+    
+    #timeline
+    
+    should "fetch the public timeline" do
+      stub_get("http://github.com/timeline.json", "timeline.json")
+      events = Octopussy.public_timeline
+      events.first['type'].should == 'FollowEvent'
+      events[1].repository.name.should == 'octopussy'
+    end
+    
+    should "fetch a user's public timeline" do
+      stub_get("http://github.com/pengwynn.json", "timeline.json")
+      events = Octopussy.public_timeline('pengwynn')
+      events.first['type'].should == 'FollowEvent'
+      events[1].repository.name.should == 'octopussy'
+    end
 
   end
 
@@ -724,7 +760,10 @@ class OctopussyTest < Test::Unit::TestCase
       event.event_type.should == 'download'
       event.repo.name.should == 'prototype'
     end
+    
+    
   end
+  
 
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Wynn Netherland
@@ -15,13 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-17 00:00:00 -05:00
+date: 2010-08-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hashie
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -30,40 +28,40 @@ dependencies:
         - 2
         - 0
         version: 0.2.0
+  name: hashie
+  prerelease: false
+  requirement: *id001
   type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: httparty
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 4
         - 5
-        version: 0.4.5
+        - 2
+        version: 0.5.2
+  name: httparty
+  prerelease: false
+  requirement: *id002
   type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: shoulda
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 2
         - 10
-        - 1
-        version: 2.10.1
+        - 0
+        version: 2.10.0
+  name: shoulda
+  prerelease: false
+  requirement: *id003
   type: :development
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: jnunemaker-matchy
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
@@ -72,12 +70,12 @@ dependencies:
         - 4
         - 0
         version: 0.4.0
+  name: jnunemaker-matchy
+  prerelease: false
+  requirement: *id004
   type: :development
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -86,12 +84,12 @@ dependencies:
         - 9
         - 4
         version: 0.9.4
+  name: mocha
+  prerelease: false
+  requirement: *id005
   type: :development
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -100,70 +98,30 @@ dependencies:
         - 2
         - 5
         version: 1.2.5
+  name: fakeweb
+  prerelease: false
+  requirement: *id006
   type: :development
-  version_requirements: *id006
 description: Simple wrapper for the GitHub API v2
 email: wynn.netherland@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.markdown
-- Rakefile
-- VERSION
-- changelog.markdown
-- lib/octopussy.rb
 - lib/octopussy/client.rb
 - lib/octopussy/event.rb
 - lib/octopussy/repo.rb
-- octopussy.gemspec
-- test/fixtures/blob.json
-- test/fixtures/branches.json
-- test/fixtures/close_issue.json
-- test/fixtures/collaborators.json
-- test/fixtures/comment.json
-- test/fixtures/contributors.json
-- test/fixtures/emails.json
-- test/fixtures/followers.json
-- test/fixtures/full_user.json
-- test/fixtures/issue.json
-- test/fixtures/issues.json
-- test/fixtures/keys.json
-- test/fixtures/labels.json
-- test/fixtures/languages.json
-- test/fixtures/list_branch_commits.json
-- test/fixtures/list_commits.json
-- test/fixtures/network.json
-- test/fixtures/network_data.json
-- test/fixtures/network_meta.json
-- test/fixtures/open_issue.json
-- test/fixtures/raw_git_data.json
-- test/fixtures/reopen_issue.json
-- test/fixtures/repo.json
-- test/fixtures/repo_search.json
-- test/fixtures/repos.json
-- test/fixtures/search.json
-- test/fixtures/show_commit.json
-- test/fixtures/tags.json
-- test/fixtures/trees.json
-- test/fixtures/user.json
-- test/helper.rb
-- test/octopussy_test.rb
-- test/repo_test.rb
+- lib/octopussy.rb
 has_rdoc: true
-homepage: http://wynnnetherland.com/projects/octopussy
+homepage: http://wynnnetherland.com/projects/octopussy/
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -178,15 +136,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Simple wrapper for the GitHub API
+summary: Wrapper for the Octopussy API
 test_files: 
 - test/helper.rb
 - test/octopussy_test.rb

data/.document

@@ -1,4 +0,0 @@
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Wynn Netherland
-
-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.markdown

@@ -1,68 +0,0 @@
-# octopussy
-
-<img src='http://upload.wikimedia.org/wikipedia/en/b/bb/007Octopussyposter.jpg' style='float: right; margin: 0 0 10px 10px'/>
-
-Simple Ruby wrapper for the GitHub v2 API. 
-
-## Installation
-
-    sudo gem install octopussy
-    
-## Some examples
-
-### Show a user
-
-    Octopussy.user('pengwynn')
-    => <#Hashie::Mash blog="http://wynnnetherland.com" company="Orrka" created_at="2008/02/25 10:24:19 -0800" email="wynn.netherland@gmail.com" followers_count=21 following_count=55 id=865 location="Dallas, TX" login="pengwynn" name="Wynn Netherland" public_gist_count=4 public_repo_count=16>
-    
-### Show who a user follows
-
-    Octopussy.following('pengwynn')
-    => ["cglee", "bryansray", "rails", "zachinglis", "wycats", "obie", "mully", "squeejee", "jderrett", "Shopify", "ReinH", "technoweenie", "errfree", "defunkt", "joshsusser", "hashrocket", "newbamboo", "bigtiger", "github", "jamis", "jeresig", "thoughtbot", "therealadam", "jnunemaker", "seaofclouds", "choan", "llimllib", "kwhinnery", "marshall", "handcrafted", "adamstac", "jashkenas", "dan", "remy", "hayesdavis", "documentcloud", "imathis", "mdeiters", "njonsson", "asenchi", "mattsa", "marclove", "webiest", "brogers", "polomasta", "stephp", "mchelen", "piyush", "davidnorth", "rmetzler", "jferris", "madrobby", "zh", "erikvold", "desandro"]
-    
-## Working with repositories
-
-For convenience, methods that require a repo argument may be passed in any of the following forms
-
-* "pengwynn/linked"
-* {:username => 'pengwynn', :name => 'linkedin'}
-* {:username => 'pengwynn', :repo => 'linkedin'}
-* instance of Repo
-
-### Show a repo
-
-    Octopussy.repo("pengwynn/linkedin")
-    => <#Hashie::Mash description="Ruby wrapper for the LinkedIn API" fork=false forks=1 homepage="http://bit.ly/ruby-linkedin" name="linkedin" open_issues=2 owner="pengwynn" private=false url="http://github.com/pengwynn/linkedin" watchers=36>
-    
-## Authenticated requests
-
-Some methods require authentication so you'll need to pass a login and an api_token. You can find your GitHub API token on your [account page](https://github.com/account)
-
-    client = Octopussy::Client.new(:login => 'pengwynn', :token => 'OU812')
-    client.follow!('adamstac')
-
-Read the full [docs](http://rdoc.info/projects/pengwynn/octopussy) or check out the [examples](http://github.com/pengwynn/octopussy/tree/master/examples)
-
-## TODO
-
-* Feed parsing
-* More examples
-
-## Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-## Credits
-
-Octopussy is inspired by [Octopi](http://github.com/fcoury/octopi) and aims to be a lightweight, less active-resourcey alternative.
-
-## Copyright
-
-Copyright (c) 2009 [Wynn Netherland](http://wynnnetherland.com), [Adam Stacoviak](http://adamstacoviak.com/). See LICENSE for details.