rMeetup 1.0 → 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d979168eaba97d900401cadf7ef5a2fc603f7e58
+  data.tar.gz: 18f87dca4c0d55f225c1f441daca6926b42996a0
+SHA512:
+  metadata.gz: 22695b99138b576c50788826ea61fd6d34ed747b47e1e749a8707812e7b04d9e1bfb7d39d6185058c1392be94b385ef4f693d9584e7d7eeb43ed48c278fa7555
+  data.tar.gz: a4a6f66269c88ab9433be369612de761cb9ed96e2585c9b46d7b1c8fb93cc2199fec9318a431e6b5c090823da2fe8b20255684aced0601671ad84a56b17fbc4e

data/LICENSE.md

@@ -0,0 +1,21 @@
+Copyright (c) 2008-2013 Jared Pace, Jason Berlinsky, Tommy Chan, Tanner Mares, Zishan Ahmad, Nikica Jokić
+
+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,65 @@
+rMeetup
+=======
+[![Gem Version](https://badge.fury.io/rb/rMeetup.svg)](http://badge.fury.io/rb/rMeetup)
+[![Build Status](https://travis-ci.org/neektza/rmeetup.svg?branch=master)](https://travis-ci.org/neektza/rmeetup)
+[![Code Climate](https://codeclimate.com/github/neektza/rmeetup.png)](https://codeclimate.com/github/neektza/rmeetup)
+[![Coverage Status](https://coveralls.io/repos/neektza/rmeetup/badge.png?branch=master)](https://coveralls.io/r/neektza/rmeetup?branch=master)
+[![Inline docs](http://inch-ci.org/github/neektza/rmeetup.svg?branch=master)](http://inch-ci.org/github/neektza/rmeetup)
+
+A Ruby wrapper for the Meetup REST API v2.
+
+Code Sample
+-----------
+
+Sample code is worth a thousand words:
+
+```ruby
+  client = RMeetup::Client.new do |config|
+    config.api_key = "API_KEY"
+  end
+  
+  results = client.fetch(:events, { event_id: 'some_id' })
+  results.each do |result|
+    # Do something with the result
+  end
+```
+
+Fetch
+-----
+
+RMeetup::Client#fetch takes a data model type and set of options as arguments. Possible data models are:
+
+* :events
+* :open_events
+* :groups
+* :rsvps
+* :cities
+* :members
+* :photos
+* :venues
+
+The options that may be passed can be found on the Meetup API documentation. Please see http://www.meetup.com/meetup_api/docs/ and look up the model that you are calling (i.e. for :events, look at the API call "GET /2/events" at http://www.meetup.com/meetup_api/docs/2/events/).
+
+Post
+----
+
+RMeetup::Client#post takes a data model type and set of options as arguments. Possible data models are:
+
+* :event_comment
+
+The options that may be passed can be found on the Meetup API documentation. Please see http://www.meetup.com/meetup_api/docs/ and look up the model that you are calling (i.e. for :event_comment, look at the API call ```POST /2/event_comment``` at http://www.meetup.com/meetup_api/docs/2/event_comment).
+
+Installation
+------------
+
+... via Rubygems/Bundler.
+
+Credits
+-------
+* [Jared Pace](https://github.com/jdpace/rmeetup) - built initial iteration
+* [Jason Berlinsky](https://github.com/Jberlinsky/rmeetup) - forked, expanded, documented for api v1.0
+* [Tommy Chan](https://github.com/tommytcchan/rmeetup) - added venues, updated to api v2.0
+* [Tanner Mares](https://github.com/tannermares/rmeetup) - check for type in base_url, fix event time and venue, also updated to api v2.0
+* [Joshua Calloway](https://github.com/joshuacalloway/rmeetup) - added post functionality and event comment creation
+* [Zishan Ahmad](https://github.com/zishan/rmeetup) - consolidated changes, updated docs
+* [Nikica Jokić](https://github.com/neektza/rmeetup) - thread-safe client refactoring, setup for TravisCI, CodeClimate, Coveralls...

data/Rakefile

@@ -1,14 +1,8 @@
-require 'rubygems'
-require 'rake'
-require 'echoe'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-Echoe.new('rMeetup','1.0') do |p|
-  p.description = "A simple Ruby gem, providing access to the Meetup API"
-  p.url         = "https://github.com/Jberlinsky/rmeetup"
-  p.author      = "Jason Berlinsky"
-  p.email       = "jason@jasonberlinsky.com"
-  p.ignore_pattern  = ["tmp/*", "script/*"]
-  p.development_dependencies  = []
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+task :default => [:spec]

data/lib/core_ext/string.rb

@@ -0,0 +1,11 @@
+class String
+  def snake_case
+    self.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").tr(".", "_").downcase
+  end
+
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map{|e| e.capitalize}.join
+  end
+end
+

data/lib/rmeetup.rb

@@ -2,68 +2,7 @@ require 'net/http'
 require 'date'
 require 'rubygems'
 require 'json'
+require 'rmeetup/client'
 require 'rmeetup/type'
 require 'rmeetup/collection'
-require 'rmeetup/fetcher'
-
-module RMeetup
-  
-  # RMeetup Errors
-  class NotConfiguredError < StandardError
-    def initialize
-      super "Please provide your Meetup API key before fetching data."
-    end
-  end
-  
-  class InvalidRequestTypeError < StandardError
-    def initialize(type)
-      super "Fetch type '#{type}' not a valid."
-    end
-  end
-  
-  # == RMeetup::Client
-  # 
-  # Essentially a simple wrapper to delegate requests to
-  # different fetcher classes who are responsible for fetching
-  # and parsing their own responses.
-  class Client
-    FETCH_TYPES = [:topics, :cities, :members, :rsvps, :events, :groups, :comments, :photos]
-    
-    # Meetup API Key
-    # Get one at http://www.meetup.com/meetup_api/key/
-    # Needs to be the group organizers API Key
-    # to be able to RSVP for other people
-    @@api_key = nil
-    def self.api_key; @@api_key; end;
-    def self.api_key=(key); @@api_key = key; end;
-    
-    def self.fetch(type, options = {})
-      check_configuration!
-      
-      # Merge in all the standard options
-      # Keeping whatever was passed in
-      options = default_options.merge(options)
-      
-      if FETCH_TYPES.include?(type.to_sym)
-        # Get the custom fetcher used to manage options, api call to get a type of response
-        fetcher = RMeetup::Fetcher.for(type)
-        return fetcher.fetch(options)
-      else
-        raise InvalidRequestTypeError.new(type)
-      end
-    end
-    
-    protected
-      def self.default_options
-        {
-          :key => api_key
-        }
-      end
-      
-      # Raise an error if RMeetup has not been
-      # provided with an api key
-      def self.check_configuration!
-        raise NotConfiguredError.new unless api_key
-      end
-  end
-end
+require 'rmeetup/version'

data/lib/rmeetup/client.rb

@@ -0,0 +1,77 @@
+require 'rmeetup/errors'
+require 'rmeetup/fetcher'
+require 'rmeetup/poster'
+
+module RMeetup
+
+  # == RMeetup::Configuration
+  #
+  # Holds various configuration data. For now it's
+  # only used to hold the API key. You can get one
+  # at http://www.meetup.com/meetup_api/key/
+  #
+  # Needs to be the group organizers API Key
+  # to be able to RSVP for other people
+  class Configuration
+    attr_accessor :api_key, :access_token
+  end
+
+  # == RMeetup::Client
+  # 
+  # Essentially a simple wrapper to delegate requests to
+  # different fetcher classes who are responsible for fetching
+  # and parsing their own responses.
+  class Client
+    # Initializes a new Client object
+    #
+    # @param opts [Hash] Options, currenlty only for providing clinet with the auth data
+    # @yield [Configuration], object with accessors :api_key and :access_token, used for providing auth data in a backward compatible way
+    # @return [RMeetup::Client]
+    def initialize(opts = {})
+      if not(opts.empty?)
+        configuration.api_key = opts[:api_key] if opts.has_key?(:api_key)
+        configuration.access_token = opts[:access_token] if opts.has_key?(:access_token)
+      else
+        yield(configuration) if block_given?
+      end
+      check_configuration!
+    end
+
+    # Delegates to appropriate RMeetup::Fetcher
+    def fetch(type, options = {})
+      RMeetup::Fetcher.for(type).fetch options.merge(auth)
+    end
+
+    # Delegates to appropriate RMeetup::Poster
+    def post(type, options = {})
+      RMeetup::Poster.for(type).post options.merge(auth)
+    end
+
+    private
+    # Creates or returns Client configuration
+    #
+    # @return [RMeetup::Configuration] Configuration is created and returned during Client initializtion and just returned otherwise
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Construct authorization part of the query. Preferes :api_key over :access_token
+    #
+    # @return [Hash] Authorization part of the query.
+    def auth
+      if configuration.api_key
+        { :key => configuration.api_key, :sign => 'true' }
+      elsif configuration.access_token
+        { :access_token => configuration.access_token }
+      end
+    end
+
+    # Ensures that API key is set during configuration.
+    #
+    # @raise [RMeetup::Error::ConfigurationError] Error is raised when API key isn't provided
+    def check_configuration!
+      fail Error::NotConfiguredError.new unless configuration.api_key || configuration.access_token
+    end
+
+  end
+end

data/lib/rmeetup/errors.rb

@@ -0,0 +1,15 @@
+module RMeetup
+  module Error
+    class NotConfiguredError < StandardError
+      def initialize
+        super "Please provide your Meetup API key before fetching data."
+      end
+    end
+
+    class InvalidRequestTypeError < StandardError
+      def initialize(type)
+        super "Fetch type '#{type}' not a valid."
+      end
+    end
+  end
+end

data/lib/rmeetup/fetcher.rb

@@ -1,38 +1,25 @@
-require "rmeetup/fetcher/base"
-require "rmeetup/fetcher/topics"
-require "rmeetup/fetcher/cities"
-require "rmeetup/fetcher/members"
-require "rmeetup/fetcher/rsvps"
-require "rmeetup/fetcher/events"
-require "rmeetup/fetcher/groups"
-require "rmeetup/fetcher/comments"
-require "rmeetup/fetcher/photos"
+require 'core_ext/string'
+require 'rmeetup/fetcher/base'
+require 'rmeetup/fetcher/cities'
+require 'rmeetup/fetcher/members'
+require 'rmeetup/fetcher/rsvps'
+require 'rmeetup/fetcher/events'
+require 'rmeetup/fetcher/open_events'
+require 'rmeetup/fetcher/groups'
+require 'rmeetup/fetcher/photos'
+require 'rmeetup/fetcher/venues'
 
 module RMeetup
   module Fetcher
-    
-    class << self
-      # Return a fetcher for given type
-      def for(type)
-        return  case type.to_sym
-                when :topics
-                  Topics.new
-                when :cities      
-                  Cities.new
-                when :members     
-                  Members.new
-                when :rsvps       
-                  Rsvps.new
-                when :events      
-                  Events.new
-                when :groups      
-                  Groups.new
-                when :comments    
-                  Comments.new
-                when :photos
-                  Photos.new
-                end
-      end 
+
+    def self.for(type)
+      name = type.to_s.camel_case.to_sym
+      if (name && constants.include?(name))
+        const_get(name).new
+      else
+        raise RMeetup::Error::InvalidRequestTypeError.new(type)
+      end
     end
+
   end
-end
+end

data/lib/rmeetup/fetcher/base.rb

@@ -1,5 +1,7 @@
 module RMeetup
   module Fetcher
+    Domain = "api.meetup.com"
+
     class ApiError < StandardError
       def initialize(error_message, request_url)
         super "Meetup API Error: #{error_message} - API URL: #{request_url}"
@@ -11,74 +13,83 @@ module RMeetup
         super "No Response was returned from the Meetup API."
       end
     end
-    
+
     # == RMeetup::Fetcher::Base
-    # 
-    # Base fetcher class that other fetchers 
-    # will inherit from.
+    #
+    # Base fetcher class that other fetchers will inherit from.
     class Base
       def initialize
         @type = nil
       end
-      
-      # Fetch and parse a response
-      # based on a set of options.
-      # Override this method to ensure
-      # neccessary options are passed
-      # for the request.
+
+      # Fetch and parse a response based on a set of options.  Override this method to ensure neccessary options are passed for the request.
+      #
+      # @param options [Hash] Options for deciding what and how to fetch
+      # @return [RMeetup::Collection] Collection of appropriate entities
       def fetch(options = {})
-        url = build_url(options)
-        
-        json = get_response(url)
-        data = JSON.parse(json)
-        
+        raise NotConfiguredError, /fetches only possible with a concrete fetcher/ if @type.nil?
+        path = path_and_query(options)
+
+        # Fetch and parse data from Meetup
+        response_body = requester(options).get(path).body || raise(NoResponseError.new)
+        data = JSON.parse(response_body)
+
         # Check to see if the api returned an error
-        raise ApiError.new(data['details'],url) if data.has_key?('problem')
-        
+        raise ApiError.new(data['details'],path) if data.has_key?('problem')
+
         collection = RMeetup::Collection.build(data)
-        
+
         # Format each result in the collection and return it
         collection.map!{|result| format_result(result)}
       end
       
-      protected
-        # OVERRIDE this method to format a result section
-        # as per Result type.
-        # Takes a result in a collection and
-        # formats it to be put back into the collection.
-        def format_result(result)
-          result
-        end
-      
-        def build_url(options)
-          options = encode_options(options)
-          
-          base_url + params_for(options)
-        end
+      def path_and_query(options)
+        base_path + query(options)
+      end
+
+      def base_path
+        "/2/#{@type}"
+      end
+
+      # Create a query string from an options hash
+      def query(options)
+        '?' + URI.encode_www_form(options)
+      end
       
-        def base_url
-          "http://api.meetup.com/#{@type}.json/"
-        end
-        
-        # Create a query string from an options hash
-        def params_for(options)
-          params = []
-          options.each do |key, value|
-            params << "#{key}=#{value}"
-          end
-          "?#{params.join("&")}"
-        end
-        
-        # Encode a hash of options to be used as request parameters
-        def encode_options(options)
-          options.each do |key,value|
-            options[key] = URI.encode(value.to_s)
-          end
-        end
-        
-        def get_response(url)
-          Net::HTTP.get_response(URI.parse(url)).body || raise(NoResponseError.new)
+      # Decides whether to use HTTP or HTTPS. HTTPS is needed if we're authoizing via the :access_token
+      #
+      # @param q [Hash] Constructed HTTP(S) query
+      # @return [Net:HTTP] Constructs an HTTP request if client is given an API key
+      # @return [Net:HTTPS] Constructs an HTTPS request if client is given an access token
+      def requester(q)
+        if q.has_key?(:api_key)
+          http
+        elsif q.has_key?(:access_token)
+          https
+        else
+          http
         end
+      end
+
+      protected
+      # OVERRIDE this method to format a result section
+      # as per Result type.
+      # Takes a result in a collection and
+      # formats it to be put back into the collection.
+      def format_result(result)
+        result
+      end
+
+      def http
+        Net::HTTP.new Domain, 80
+      end
+
+      def https
+        c = Net::HTTP.new Domain, 443
+        c.use_ssl = true
+        c
+      end
+
     end
   end
-end
+end