rubeetup 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e43ac5b43c6a21aa36bd9be908cafe94977ad7b
+  data.tar.gz: 63a251ccdb7a80f09835a247797d9f4f33af57b9
+SHA512:
+  metadata.gz: f8528053c9beea9268370c27e5b4add52fff3f3094a0bdc9a06f3d3784532a638559f2341dcc4df2cf05788abfe117e7e9fbb274694244afd2eca12069aaaf16
+  data.tar.gz: 5bb0bb297c6a36bf1bd80727f373272b31cf78904c2e84ab841e6f1fab10a5fe18849ade6cef722035ce9d8ee159345ee66b2bea4e9c9717204ce67ce958413b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/.coveralls.yml

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.1
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubeetup.gemspec
+gemspec

data/README.md

@@ -0,0 +1,173 @@
+<a href="https://travis-ci.org/mike-vascelli/rubeetup"><img src="https://travis-ci.org/mike-vascelli/rubeetup.svg?branch=master"/></a>
+<a href="https://codeclimate.com/github/mike-vascelli/rubeetup"><img src="https://codeclimate.com/github/mike-vascelli/rubeetup/badges/gpa.svg" /></a>
+<a href='https://gemnasium.com/mike-vascelli/rubeetup'><img src="https://gemnasium.com/mike-vascelli/rubeetup.svg" alt="Dependency Status" /></a>
+<a href='https://coveralls.io/r/mike-vascelli/rubeetup'><img src='https://coveralls.io/repos/mike-vascelli/rubeetup/badge.svg' alt='Coverage Status' /></a>
+<a href="https://inch-ci.org/github/mike-vascelli/rubeetup"><img src="http://inch-ci.org/github/mike-vascelli/rubeetup.svg?branch=master"/></a>
+
+
+# Rubeetup
+
+## Overview
+
+This gem allows you to interact with the `Meetup.com` API in a simple and direct way. It gives you access to all of the available API methods (full `CRUD`), and it also makes sure that all the required parameters are provided with each request.
+
+For more information on the Meetup API itself, visit: http://www.meetup.com/meetup_api
+
+
+### Requests' Naming Convention
+
+They begin with the action to perform on a resource: (i.e. `create`, `get`, `edit`, `delete`) and are followed by underscore, and then the name of the resource requested (as in the Meetup API).
+#### Eg.
+    http://www.meetup.com/meetup_api/docs/2/open_events/
+
+    resource:       open_events
+
+    action:         get
+
+    request name:   get_open_events
+
+All the requests on Rubeetup follow this scheme.
+
+
+## Supported Requests
+
+get_open_events,   get_concierge,   get_events,   create_event,   get_event,   edit_event,   delete_event,   get_event_comments,   create_event_comment,   get_event_comment,   delete_event_comment,   create_event_comment_flag,   create_event_comment_subscribe,   delete_event_comment_subscribe,   create_event_comment_like,   delete_event_comment_like,   get_event_comment_likes,   get_event_ratings,   create_event_rating,   create_attendance,   get_attendance,   create_event_payments,   create_watchlist,   delete_watchlist,   get_boards,   get_discussions,   get_discussion_posts,   get_categories,   get_cities,   get_dashboard,   get_activity,   get_groups,   get_comments,   create_group_photo,   get_find_groups,   get_group,   edit_group,   create_group_topics,   delete_group_topics,   get_recommended_groups,   create_recommended_groups_ignores,   get_similar_groups,   get_members,   get_member,   edit_member,   delete_member_photo,   create_member_photo,   get_status,   get_notifications,   create_notifications_read,   get_oembed,   delete_photo,   get_photo_comments,   create_photo_comment,   get_photo_albums,   get_photos,   create_photo_album,   create_photo,   get_profiles,   create_profile,   edit_profile,   get_profile,   delete_profile,   create_member_approvals,   delete_member_approvals,   get_rsvps,   create_rsvp,   edit_rsvp,   get_rsvp,   get_topic_categories,   get_topics,   get_recommended_group_topics,   get_open_venues,   get_venues,   get_group_venues,   get_recommended_venues,   create_venue
+
+### Authorization
+Rubeetup will need a Meetup api key to successfully perform the requests. This can be obtained by signing-up at http://www.meetup.com, and by requesting a key for your account.
+Note that in order to `edit`, `create`, or `delete` any resource in the API, you must first obtain the privileges to do those actions. This usually means becoming an organizer for a group. This can be achieved by either starting a meetup group, or by being granted the authorization by a current organizer of a group. If you want to experiment with the API or simply do some live testing, then you can request to become an organizer for the <tt>Meetup API Testing Sandbox Group</tt>.
+
+Visit this link http://www.meetup.com/Meetup-API-Testing for more information.
+
+## Usage
+
+```ruby
+auth = key: 'val'
+
+# If you wish to provide auth data for each instance,
+# then pass it to the Rubeetup.setup call as an argument:
+#
+requester = Rubeetup.setup(auth)
+
+# Otherwise you can pass default auth data once and be done with it:
+#
+Rubeetup.default_auth(auth)
+requester = Rubeetup.setup
+
+
+# Each request will take a Hash of options.
+# Check in rubeetup/requests_lib/meetup_catalog.rb, or in the
+# MeetupCatalog documentation, or at: http://www.meetup.com/meetup_api
+# for a list of required and available parameters for your specific request.
+#
+# Rubeetup will raise an Error if any request is attempted without
+# providing all the required parameters.
+#
+events = requester.get_events(group_urlname: 'Meetup-API-Testing')
+
+
+# Every request returns an array of results, and you can safely iterate over them.
+# Furthermore, each result stored in the array is a symbol-keyed Hash.
+#
+events.each do |event|
+  # Each element is a Hash, so you can simply do:
+  puts event[:name]
+
+  # But Rubeetup also allows you to access elements' keys in OO-style:
+  puts event.name, event.time, event.duration, ...
+
+  venue = event.venue
+  puts venue[:address_1]
+  puts venue[:city]
+end
+
+pic = requester.create_member_photo(photo: 'spec/test_files/cat.png').first
+puts pic.photo_url, pic.member_photo_id
+
+event = requester.create_event(group_id: testing_group_id,
+                               group_urlname: testing_group_urlname,
+                               name: 'test').first
+puts event.id
+```
+Take a look at the file `spec/lib/integration_spec.rb` to see examples for all the requests
+
+To check each request's own required parameters:
+Look in `lib/rubeetup/requests_lib/meetup_catalog.json`, or at: http://www.meetup.com/meetup_api
+
+To find out about all the available response attributes visit the Meetup API documentation:
+http://www.meetup.com/meetup_api
+
+For example, for the `events` API request in the `Usage` example above, check this link:
+http://www.meetup.com/meetup_api/docs/2/events
+
+
+
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubeetup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubeetup
+
+## Ruby Interpreter Compatibility
+
+Rubeetup has been tested on the following ruby interpreters:
+
+- 2.2.1
+- 2.2
+- 2.1
+- 2.0.0
+- 1.9.3
+- 1.9.2
+
+## Runtime Dependencies
+
+- multipart-post
+
+## Development
+
+After checking out the repo, run `bin/setup`, or `bundle install` to install dependencies. Then, run `rake` or `rspec` to run the tests. You can also run `bin/console` or `bundle console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports are more than welcome! Here's the link: https://github.com/mike-vascelli/rubeetup/issues
+
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Mike Vascelli
+
+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,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubeetup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rubeetup/errors.rb

@@ -0,0 +1,32 @@
+module Rubeetup
+  ##
+  # Raised when the user attempts to create an instance of Requester with
+  # invalid auth data
+  #
+  InvalidAuthenticationError = Class.new(StandardError)
+
+  ##
+  # Raised when the user attempts to create an instance of Request, but the
+  # request either does not exist, or it has one or more missing arguments
+  #
+  RequestError = Class.new(StandardError)
+
+  ##
+  # Custom Error to wrap Rubeetup::RequestResponse objects in case of error
+  # while performing a request
+  #
+  class MeetupResponseError < StandardError
+
+    ##
+    # @return [Rubeetup::RequestResponse] the failed request's response
+    #
+    attr_reader :response
+
+    ##
+    # @param [Rubeetup::RequestResponse] response the failed request's response
+    #
+    def initialize(response)
+      @response = response
+    end
+  end
+end

data/lib/rubeetup/request.rb

@@ -0,0 +1,133 @@
+require 'set'
+
+module Rubeetup
+  ##
+  # Represents API requests. Provides for their own validation and execution
+  #
+  class Request
+    include Rubeetup::RequestsCatalog
+    include Rubeetup::Utilities
+
+    ##
+    # @return [Symbol] name the name of the request as input by the user
+    #
+    attr_reader :name
+
+    ##
+    # @return [Symbol] http_verb the http_verb for the request
+    #
+    attr_reader :http_verb
+
+    ##
+    # @return [String] method_path the path of the Meetup API resource
+    #
+    attr_reader :method_path
+
+    ##
+    # @return [Hash{Symbol=>String}] options holds the request's options
+    #
+    attr_reader :options
+
+    ##
+    # @return [Rubeetup::Sender] sender the request's chosen sender
+    #
+    attr_reader :sender
+
+    ##
+    # @return [Lambda] multipart if present it contains the multipart POST logic
+    #
+    attr_reader :multipart
+
+    ##
+    # @param [Hash{Symbol=>String}] args holds the request's data
+    # @option args [Symbol] :name the full request's name
+    # @option args [Hash{Symbol=>String}] :options holds the request's options
+    # @option args [Symbol] :http_verb the request's http_verb
+    #
+    def initialize(args = {})
+      @name = args[:name]
+      @options = args[:options]
+      validate_request
+      @http_verb = args[:http_verb]
+      @method_path = request_path.call(@options)
+      @multipart = request_multipart
+      @sender = Rubeetup::RequestSender.new
+    end
+
+    ##
+    # Completes this request
+    # @return [Array<Rubeetup::ResponseWrapper>] the request's response
+    #
+    def execute
+      sender.get_response(self)
+    end
+
+    ##
+    # For debugging purposes
+    #
+    def to_s
+      <<-DOC.gsub(/^ {8}/, '')
+        \nREQUEST
+        name => #{name}
+        verb => #{http_verb}
+        path => #{method_path}
+        options => #{options.inspect}\n
+      DOC
+    end
+
+    private
+
+    def validate_request
+      verify_existence
+      validate_options
+    end
+
+    def verify_existence
+      fail error_class, existence_message unless is_in_catalog?
+    end
+
+    def validate_options
+      fail error_class, options_message unless has_all_required_options?
+    end
+
+    ##
+    # Uses sets to make sure that there is at least a set of required parameters
+    # which is a subset of the arguments passed to the request
+    # @return [Boolean] whether all the required arguments have been passed
+    #
+    def has_all_required_options?
+      required_keys_sets = required_options.map do |elem|
+        elem.respond_to?(:to_set) ? elem.to_set : Set[elem]
+      end
+      return true if required_keys_sets.empty?
+      option_keys_set = options.keys.to_set
+      required_keys_sets.any? { |set| set.subset? option_keys_set }
+    end
+
+    def existence_message
+      <<-DOC.gsub(/^ {8}/, '')
+        The provided request => '#{name}' is an invalid request.
+        This request does not exist in the catalog of supported requests.
+        Please consult rubeetup/requests_lib/meetup_catalog.rb, or the provided
+        documentation for the complete list of requests.
+      DOC
+    end
+
+    def options_message
+      <<-DOC.gsub(/^ {8}/, '')
+        This request cannot be completed as is.
+        The provided arguments => '#{options.inspect}' miss one or more
+        required parameters.
+        The request '#{name}' requires the following parameters:
+        '#{required_options.inspect}'
+        Please consult rubeetup/requests_lib/meetup_catalog.rb, or the provided
+        documentation for the complete list of requests, and their respective
+        required parameters.
+      DOC
+    end
+
+    def error_class
+      Rubeetup::RequestError
+    end
+  end
+end

data/lib/rubeetup/request_builder.rb

@@ -0,0 +1,68 @@
+module Rubeetup
+  ##
+  # Allows a Requester object to compose a Request instance with the passed data
+  #
+  module RequestBuilder
+    class << self
+      ##
+      # Creates an instance of the chosen request type
+      # @note only preliminary error checking on the request is performed here.
+      # @param [Symbol] name the request's name
+      # @param [Hash{Symbol=>String}] args holds the request's options
+      # @return [Rubeetup::Request] the newly created Request instance
+      #
+      def compose_request(name, args)
+        verb = get_verb(name)
+        validate_verb(verb)
+        request_type.new(
+            name: name,
+            http_verb: infer_http_verb(verb),
+            options: args.first
+        )
+      end
+
+      private
+
+      def request_type
+        Rubeetup::Request
+      end
+
+      def verbs
+        { create: :post, get: :get, edit: :post, delete: :delete }
+      end
+
+      ##
+      # Parses the request name, and attempts to split it around the leftmost
+      # underscore char. If the name is properly formed, then the left half
+      # is the verb of the request
+      # @param [Symbol] name the request name
+      # @return [Symbol] if name contains the required underscore char
+      # @return [nil] if name is invalid
+      #
+      def get_verb(name)
+        pos = (name =~ /_/)
+        pos ? name[0...pos].to_sym : nil
+      end
+
+      def validate_verb(verb)
+        valid_verbs = verbs.keys
+        fail Rubeetup::RequestError, error_message(verb, valid_verbs) unless
+          valid_verbs.include? verb
+      end
+
+      def error_message(verb, valid_verbs)
+        <<-DOC.gsub(/^ {10}/, '')
+          '#{verb}' is an invalid method.
+          The only available requests must begin with any of:
+          #{valid_verbs.join(', ')}
+          Followed by underscore, and a Meetup request name.
+          Consult the documentation for a complete list of available requests.
+        DOC
+      end
+
+      def infer_http_verb(verb)
+        verbs[verb]
+      end
+    end
+  end
+end

data/lib/rubeetup/request_response.rb

@@ -0,0 +1,88 @@
+require 'json'
+
+module Rubeetup
+  ##
+  # Packages a response, and provides for its validation
+  #
+  class RequestResponse
+    include Rubeetup::Utilities
+
+    ##
+    # @return [Net::HTTPResponse] response the raw response from the sender
+    #
+    attr_reader :response
+
+    ##
+    # @return [Hash{Symbol=>...}] parsed_body the JSON-parsed body of the response.
+    #   It is a Hash with all the keys as Symbols
+    #
+    attr_reader :parsed_body
+
+    ##
+    # @return [Rubeetup::Request] the request which caused this response
+    #
+    attr_reader :request
+
+    ##
+    # @param [Net::HTTPResponse] raw_data the raw response from the sender
+    #
+    def initialize(sender)
+      @response = sender.response_data
+      @request = sender.request
+      body =  @response.body
+      @parsed_body = blank?(body) ? [] : parse(body)
+    end
+
+    ##
+    # If the request was successful, then creates a collection of
+    # Rubeetup::ResponseWrapper instances.
+    # @return [Array<Rubeetup::ResponseWrapper>] a collection containing the response's data
+    #
+    def data
+      fail error_class.new(self), error_message unless success?
+      collection = collectionize(parsed_body)
+      collection.map {|elem| wrapper_class.new(elem)}
+    end
+
+    # Consider implementing pagination
+    #def prev; end
+    #def next; end
+    #def all; end # Calls #next until no more and returns all the results at once
+
+    private
+
+    def success?
+      response.is_a? Net::HTTPSuccess
+    end
+
+    def error_class
+      Rubeetup::MeetupResponseError
+    end
+
+    def wrapper_class
+      Rubeetup::ResponseWrapper
+    end
+
+    def collectionize(data)
+      return data if data.is_a? Array
+      data[:results] || [data]
+    end
+
+    def parse(body)
+      begin
+        JSON.parse(body, symbolize_names: true)
+      rescue
+        body
+      end
+    end
+
+    def error_message
+      <<-DOC.gsub(/^ {8}/, '')
+        An error was encountered while processing the following request:
+        #{request}
+        Here's some information to describe the error, and/or its causes:
+        #{parsed_body}
+      DOC
+    end
+  end
+end

data/lib/rubeetup/request_sender.rb

@@ -0,0 +1,93 @@
+require 'net/http/post/multipart'
+
+module Rubeetup
+  ##
+  # Responsible for sending responses over an http connection
+  #
+  class RequestSender
+    include Rubeetup::Utilities
+
+    ##
+    # Destination host
+    #
+    HOST = 'api.meetup.com'
+
+    ##
+    # @return [Net::HTTP] this Sender's http connection
+    #
+    attr_reader :http
+
+    ##
+    # @return [Rubeetup::Request] this Sender's request job
+    #
+    attr_reader :request
+
+    ##
+    # @return [Net::HTTPResponse] the response data obtained from the request
+    #
+    attr_reader :response_data
+
+    def initialize
+      @http = Net::HTTP.new(HOST)
+    end
+
+    ##
+    # Performs a request and returns back the response
+    # @param [Rubeetup::Request] request the request instance to be sent
+    # @return [Array<Rubeetup::ResponseWrapper>] the request response
+    #
+    def get_response(request)
+      @request = request
+      @response_data = fetch
+      response_class.new(self).data
+    end
+
+    private
+
+    def fetch
+      request.http_verb == :post ? (req = post) : (req = get_or_delete)
+      http.request(req)
+    end
+
+    def get_or_delete
+      path = "#{request.method_path}?#{stringify(request.options)}"
+      http_method_class.new(path)
+    end
+
+    def post
+      request.multipart ? multipart_post : url_encoded_post
+    end
+
+    def url_encoded_post
+      req = http_method_class.new(request.method_path)
+      req.set_form_data(request.options)
+      req
+    end
+
+    def multipart_post
+      encode_resources
+      http_method_class.new(request.method_path, request.options)
+    end
+
+    def encode_resources
+      request.multipart.call(request.options)
+    end
+
+    def http_method_class
+      class_name = request.http_verb.capitalize.to_s
+      if request.multipart
+        Net::HTTP::Post::Multipart
+      else
+        Net::HTTP.const_get(class_name.to_sym)
+      end
+    end
+
+    def response_class
+      Rubeetup::RequestResponse
+    end
+
+    def handler_class
+      Typhoeus::Request
+    end
+  end
+end