holman-brightkitey 0.1.0

data/README.markdown

@@ -0,0 +1,58 @@
+## brightkitey
+
+by [Zach Holman](http://zachholman.com) ([brightkite](http://brightkite.com/people/holman))
+
+brightkitey is a cute little wrapper around Brightkite's API. It's possibly horribly broken and incomplete, but it's getting there. Pull requests welcome and appreciated.
+
+## installation and usage
+
+    gem sources -a http://gems.github.com
+    sudo gem install holman-brightkitey
+
+To get a feel for what you're in for, check out the [Brightkite REST API](http://groups.google.com/group/brightkite-api/web/rest-api). The [object reference](http://groups.google.com/group/brightkite-api/web/api-object-reference) might be helpful, too. Some fun things you can do:
+
+### authentication
+    require 'rubygems'
+    require 'brightkitey'
+    
+    Brightkitey.authenticate(:user => 'dr_strangelove', :password => 'cant-allow-gaps')
+    Brightkitey.logged_in? # quick login check
+    
+### brightkitein' around
+    
+    me = Brightkitey.me
+    me.friends.first.checkins # => grab a friend's checkins
+    
+    home = me.checkins.first.place
+    me.checkin(home) # => check yourself in at home
+    
+    Brightkitey::Place.search("arby's") # => mmmm... I'm thinking Arby's. If you're logged in, this'll pull in those closest to you first.
+
+## thanks
+
+The official [Lighthouse](http://github.com/Caged/lighthouse-api) wrapper was fairly helpful for a newbie like me to wrap my head around. Thankee, Justin.
+
+## license
+
+(The MIT License)
+
+Copyright (c) 2008 Zach Holman
+
+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/lib/brightkitey.rb

@@ -0,0 +1,127 @@
+require 'rubygems'
+require 'activeresource'
+
+module Brightkitey
+  VERSION = '0.1.0'
+  
+  attr_accessor :logged_in
+
+  class << self
+    def authenticate(options)
+      Brightkitey::Base.user = options[:user]
+      Brightkitey::Base.password = options[:password]
+      Brightkitey::Me.person
+      @logged_in = true
+    rescue ActiveResource::UnauthorizedAccess
+      false
+    end
+    
+    def logged_in?
+      @logged_in == true
+    end
+    
+    def me
+      Brightkitey::Me.person
+    end
+  end
+  
+  class Base < ActiveResource::Base
+    def self.inherited(base)
+      base.site = "http://brightkite.com/"
+      base.element_name = base.to_s.split('::').last.downcase
+      super
+    end    
+  end
+  
+  class Block < Base
+  end
+  
+  class Checkin < Base
+  end
+  
+  class Comment < Base
+  end
+  
+  class DirectMessage < Base
+  end
+  
+  class Note < Base
+  end
+  
+  class Objekt < Base
+    self.element_name = 'object'
+  end
+  
+  class Person < Base
+    def checkins
+      Checkin.find(:all, :from => "/people/#{login}/objects.xml", :params => {:filters => :checkins})
+    end
+    
+    def photos
+      Photo.find(:all, :from => "/people/#{login}/objects.xml", :params => {:filters => :photos})
+    end
+    
+    def objects(options = {})
+      Objekt.find(:all, :from => "/people/#{login}/search.xml", :params => options)
+    end
+    
+    def friends
+      Friend.find(:all, :from => "/people/#{login}/friends.xml")
+    end
+    
+    def pending_friends
+      Friend.find(:all, :from => "/people/#{login}/pending_friends.xml")      
+    end
+    
+    def self.search(query)
+      Person.find(:all, :from => "/people/search.xml", :params => {:query => query})
+    end
+  end
+  
+  class Friend < Person
+  end
+  
+  class Photo < Base
+    self.element_name = 'object'
+    
+    def comments
+      Comment.find(:all, :from => "/objects/#{id}/comments")
+    end
+  end
+  
+  class Place < Base
+    def checkins
+      Checkin.find(:all, :params => options.update(:project_id => id))
+    end
+    
+    def self.search(query)
+      Place.find(:all, :from => :search, :params => {:q => query})
+    end
+  end
+
+  class Me < Person
+    def self.person
+      Me.find(:one, :from => '/me.xml')
+    end
+ 
+    def sent_messages
+      DirectMessage.find(:all, :from => '/me/sent_messages.xml')
+    end
+    
+    def received_messages
+      DirectMessage.find(:all, :from => '/me/received_messages.xml')
+    end
+    
+    def blocks
+      Block.find(:all, :from => '/me/blocked_people.xml')
+    end
+  
+    def checkin(place)
+      place = place.id if place.kind_of?(Place)
+      Brightkitey::Place.connection.post("/places/#{place}/checkins",'')
+    rescue ActiveResource::Redirection
+      true
+    end
+  end
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: holman-brightkitey
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Zach Holman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-20 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: A cute little Ruby wrapper around Brightkite's API
+email: 
+- ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/brightkitey.rb
+has_rdoc: false
+homepage: http://github.com/holman/brightkitey
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ""
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A cute little Ruby wrapper around Brightkite's API
+test_files: []
+