BRIMIL01-meetup_api 0.1.1

data/README

@@ -0,0 +1,67 @@
+= Meetup API
+
+== Developers
+* {Bosco So}[http://boscomonkey.com] <rubymeetup _AT_ boscoso _DOT_ com>
+
+== Description
+Meetup API is a port of the official Python client released by Meetup
+for their API. This port provides an object based API to query or
+update Meetup data via pure Ruby.  It hides the ugly HTTP/REST calls
+from your code.
+
+The Meetup Python API client can be found at
+http://www.meetup.com/meetup_api/clients/
+
+== External Dependencies
+* Ruby (tested with 1.8.6)
+* net/http
+* json (tested with versions: 1.1.3)
+
+== Usage Examples
+Start by creating an instance of the Meetup object with your API key
+as the constructor argument. You can get your API key at
+http://www.meetup.com/meetup_api/key/
+
+mu = MeetupApi::Client.new 'your_api_key'
+
+Then, you can query the API directly by using one of the following
+methods:
+
+mu.get_events HASH_PARAMS
+mu.get_rsvps HASH_PARAMS
+
+Call the method using keyword args containing the parameters of the
+query (identical to parameters described on the main documentation
+page - http://www.meetup.com/meetup_api/docs/). For example, find all
+the events around zip 94108:
+
+local_events = mu.get_events :zip => 94108
+
+Another example, find the event with id 9348580 (the results method
+still returns an array, but it only has 1 element):
+
+ruby_events = mu.get_events :id => 9348580
+
+The returned value will be an object of type
+MeetupApi::ApiResponse. This object's property meta is a Hash
+containing all the metadata from the query results. The property
+results is an Array containing objects of type MeetupApi::Event or
+MeetupApi::Rsvp (depending which MeetupApi::Client method was
+used). These objects support additional methods that will make API
+calls to get more information (taking the MeetupApi::Client object as
+an argument to make the request). For example, take the ruby event
+from above and retrieve its RSVP list:
+
+first_event = ruby_events.results.first
+rsvps = first_event.get_rsvps mu
+
+Of course, if you just wanted to only get the RSVP's, you can simply
+call MeetupApi::Client#get_rsvps directly:
+
+rsvps = mu.get_rsvps :event_id => 9348580
+
+== To Do
+* Currently, only MeetupApi::Client#get_events and get_rsvps are
+  implemented; so, finish the other client methods.
+* Implement OAuth
+

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'meetup_api'
+  s.version          = '0.1.0'
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README)
+  s.rdoc_options     = %w(--main README)
+  s.summary          = "Ruby port of Meetup's official Python API client"
+  s.author           = 'Bosco So'
+  s.email            = 'git@boscoso.com'
+  s.homepage         = 'http://boscoso.com'
+  s.files            = %w(README Rakefile) + Dir.glob("{lib,test}/**/*")
+  
+  s.add_dependency('json', '= 1.1.3')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/meetup_api.rb

@@ -0,0 +1,189 @@
+require 'net/http'
+require 'rubygems'
+require 'json'
+
+module MeetupApi
+  DEV = ''
+  API_BASE_URL = "http://api#{DEV}.meetup.com/"
+  EVENTS_URI = 'events'
+  RSVPS_URI = 'rsvps'
+  MEMBERS_URI = 'members'
+  GROUPS_URI = 'groups'
+  PHOTOS_URI = 'photos'
+  TOPICS_URI = 'topics'
+  COMMENTS_URI = 'comments'
+  
+  class Client
+    def initialize(apiKey)
+      @key = apiKey
+    end
+    
+    def get_events(args)
+      ApiResponse.new(fetch(EVENTS_URI, args), Event)
+    end
+
+    def get_rsvps(args)
+      ApiResponse.new(fetch(RSVPS_URI, args), Rsvp)
+    end
+    
+    def get_members(args)
+      ApiResponse.new(fetch(MEMBERS_URI, args), Member)
+    end
+    
+    def get_groups(args)
+      ApiResponse.new(fetch(GROUPS_URI, args), Group)
+    end
+    
+    def get_photos(args)
+      ApiResponse.new(fetch(PHOTOS_URI, args), Photo)
+    end
+    
+    def get_topics(args)
+      ApiResponse.new(fetch(TOPICS_URI, args), Photo)
+    end
+    
+    def get_comments(args)
+      ApiResponse.new(fetch(COMMENTS_URI, args), Comment)
+    end
+
+    def fetch(uri, url_args={})
+      url_args['format'] = 'json'
+      url_args['key'] = @key if @key
+      args = URI.escape(url_args.collect{|k,v| "#{k}=#{v}"}.join('&'))
+      url = "#{API_BASE_URL}#{uri}/?#{args}"
+      data = Net::HTTP.get_response(URI.parse(url)).body
+      
+      # ugh - rate limit error throws badly formed JSON
+      begin
+        JSON.parse(data)
+      rescue Exception => e
+        raise BaseException(e)
+      end
+    end
+  end
+
+  class ApiResponse
+    attr_reader :meta, :results
+
+    def initialize(json, klass)
+      if (meta_data = json['meta'])
+        @meta = meta_data
+        @results = json['results'].collect {|hash| klass.new hash}
+      else
+        raise ClientException.new(json)
+      end
+    end
+  end
+  
+  # Turns a hash into an object - see http://tinyurl.com/97dtjj
+  class Hashit
+    def initialize(hash)
+      hash.each do |k,v|
+        # create and initialize an instance variable for this key/value pair
+        self.instance_variable_set("@#{k}", v)
+        # create the getter that returns the instance variable
+        self.class.send(:define_method, k, proc{self.instance_variable_get("@#{k}")})
+        # create the setter that sets the instance variable (disabled for readonly)
+        ##self.class.send(:define_method, "#{k}=", proc{|v| self.instance_variable_set("@#{k}", v)})
+      end
+    end
+  end
+  
+  # Base class for an item in a result set returned by the API.
+  class ApiItem < Hashit
+  end
+  
+  class Event < ApiItem
+    def get_rsvps(apiclient, extraparams={})
+      extraparams['event_id'] = self.id
+      apiclient.get_rsvps extraparams
+    end
+    
+    def to_s
+      "Event #{self.id} named #{self.name} at #{self.time} (url: #{self.event_url})"
+    end
+  end
+  
+  class Rsvp < ApiItem
+    def to_s
+      "Rsvp by #{self.name} (#{self.link}) with comment: #{self.comment}"
+    end
+  end
+  
+  class Group < ApiItem
+    def get_members(apiclient, extraparams={})
+      extraparams['group_id'] = self.id
+      apiclient.get_members extraparams
+    end
+    
+    def get_photos(apiclient, extraparams={})
+      extraparams['group_id'] = self.id
+      apiclient.get_photos extraparams
+    end
+    
+    def get_comments(apiclient, extraparams={})
+      extraparams['group_id'] = self.id
+      apiclient.get_comments extraparams
+    end
+    
+    def to_s
+      "Group #{self.id} named #{self.name}"
+    end
+  end
+  
+  class Member < ApiItem  
+    def to_s
+      "Member #{self.id} named #{self.name}"
+    end
+  end
+  
+  class Photo < ApiItem
+    def to_s
+      "Photo #{self.id} named #{self.name}"
+    end
+  end
+  
+  class Topic < ApiItem
+    def get_photos(apiclient, extraparams={})
+      extraparams['topic_id'] = self.id
+      apiclient.get_photos extraparams
+    end
+    
+    def to_s
+      "Topic #{self.id} named #{self.name}"
+    end
+  end
+  
+  class Comment < ApiItem
+    def to_s
+      "Comment #{self.id} named #{self.name}"
+    end
+  end
+  
+  # Base class for unexpected errors returned by the Client
+  class BaseException < Exception
+    attr_reader :problem
+
+    def initialize(e)
+      @problem = e
+    end
+    
+    def to_s
+      "#{self.problem}"
+    end
+  end
+
+  class ClientException < BaseException
+    attr_reader :description
+    
+    def initialize(error_json)
+      @description = error_json['details']
+      @problem = error_json['problem']
+    end
+    
+    def to_s
+      "#{self.problem}: #{self.description}"
+    end
+  end
+
+end

data/test/api_key.README

@@ -0,0 +1,4 @@
+# Copy this file to api_key.rb but make sure you get a real key first
+# from http://www.meetup.com/meetup_api/key/
+#
+API_KEY = "dummy key"

data/test/meetup_api_tester.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require File.join(File.expand_path(File.dirname(__FILE__)),
+                  "..", "lib", "meetup_api")
+
+class MeetupApiTester < Test::Unit::TestCase
+  
+  def setup
+    require File.join(File.expand_path(File.dirname(__FILE__)), 'api_key')
+
+    @key = API_KEY
+    @api = MeetupApi::Client.new(@key)
+  end
+  
+  def test_instantiate_new_client
+  end
+  
+  def test_fetch
+    # 8337541 is ID for 'My Rake is Bigger than your Rake (Ooga Labs)'
+    json = @api.fetch(MeetupApi::RSVPS_URI, :event_id => 8337541)
+    assert_not_nil(json, 'json cannot be nil')
+    assert_instance_of Hash, json
+    assert_equal(2, json.keys.size, 'valid JSON should have only 2 keys')
+    json
+  end
+  
+  def test_fetch_meta
+    json = test_fetch
+    meta = json['meta']
+    assert_not_nil(meta, "result metadata can't be nil")
+  end
+  
+  def test_fetch_results
+    json = test_fetch
+    results = json['results']
+    assert_not_nil(results, "result data can't be nil")
+    assert_instance_of Array, results
+    assert_equal(62, results.size, "should have 62 RSVP's")
+  end
+  
+  def test_fetch_missing_2nd_argument
+    json = @api.fetch(MeetupApi::RSVPS_URI)
+    assert_not_nil(json)
+  end
+    
+  def test_fetch_missing_event_id
+    json = @api.fetch(MeetupApi::RSVPS_URI)
+    assert_instance_of Hash, json
+    assert_equal(2, json.keys.size, 'valid JSON should have only 2 keys')
+    assert_not_nil(json['details'])
+    assert_not_nil(json['problem'])
+  end
+  
+  def test_fetch_unauthorized
+    client = MeetupApi::Client.new('invalid_key')
+    json = client.fetch(MeetupApi::RSVPS_URI, :event_id => 8337541)
+    assert_instance_of Hash, json
+    assert_equal(2, json.keys.size, 'valid JSON should have only 2 keys')
+    assert_not_nil(json['details'])
+    assert_not_nil(json['problem'])
+  end
+
+  
+  def test_rsvp_valid
+    ret = @api.get_rsvps :event_id => 8337541
+    verify_my_rake_is_bigger_than_your_rake ret
+  end
+  
+  def test_rsvp_missing_id
+    begin
+      ret = @api.get_rsvps({})
+      flunk 'previous call should raise'
+    rescue MeetupApi::ClientException => e
+      assert_not_nil e.description
+      assert_not_nil e.problem
+    end
+  end
+  
+  def test_events
+    ret = @api.get_events :id => 8337541, :after => '01011970'
+    assert_not_nil ret.meta
+    assert_not_nil ret.results
+    assert_instance_of Array, ret.results
+    assert_equal 1, ret.results.size
+    ret
+  end
+  
+  def test_events_rsvps
+    events = test_events
+    rsvps = events.results.first.get_rsvps @api
+    verify_my_rake_is_bigger_than_your_rake rsvps
+  end
+  
+  private
+  
+  def verify_my_rake_is_bigger_than_your_rake(ret)
+    assert_not_nil ret, "RSVP's for 'My Rake...' event should not be nil"
+    assert_not_nil ret.meta
+    assert_not_nil ret.results
+    assert_instance_of Array, ret.results
+    assert_equal 62, ret.results.size
+    ret.results.each {|r| assert_instance_of MeetupApi::Rsvp, r}
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: BRIMIL01-meetup_api
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Bosco So
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: 
+email: user@example.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- lib/meetup_api.rb
+- test/api_key.README
+- test/meetup_api_tester.rb
+has_rdoc: true
+homepage: http://example.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: Ruby port of Meetup's official Python API client
+test_files: []
+