rubeetup 0.0.1

data/lib/rubeetup/utilities.rb

@@ -0,0 +1,51 @@
+module Rubeetup
+  ##
+  # Provides some miscellaneous methods for mix-ins
+  #
+  module Utilities
+    ##
+    # Determines if the object is not blank
+    # (see #blank?)
+    #
+    def present?(obj)
+      !blank?(obj)
+    end
+
+    ##
+    # @param [Object] obj an object
+    # @return [Boolean] whether the object is blank as per Ruby Active Support
+    #
+    def blank?(obj)
+      obj.nil? || obj == false || obj.empty? || obj =~ /^\s+$/
+    end
+
+    ##
+    # Generates a string of key values to include in URL's
+    # @param [Hash{Symbol=>String}] options holds options for a request
+    # @return [String] a sringified representation of a Hash of options
+    #
+    def stringify(options)
+      return '' unless options.respond_to? :map
+      options.map { |key, val| "#{key}=#{val}" if key && val }.compact.join('&')
+    end
+
+    ##
+    # Transforms the strings into a possibly nested collection, into symbols
+    # @note For speed and simplicity no error checking is performed
+    # @param [Array<String, Array...>] array a possibly recursive collection of strings
+    # @return [Array<Symbol, Array...>] a possibly recursive collection of Symbols
+    #
+    def collection_symbolyzer(array)
+      array.map {|elem| elem.is_a?(String) ? elem.to_sym : collection_symbolyzer(elem)}
+    end
+
+    ##
+    # Gives you the dir where all the request catalogs should be stored
+    # @return [String] the directory where you should store request catalogs
+    #
+    def catalog_dir
+      'lib/rubeetup/requests_lib/'
+    end
+  end
+end
+

data/lib/rubeetup/version.rb

@@ -0,0 +1,6 @@
+module Rubeetup
+  ##
+  # Current gem version
+  #
+  VERSION = '0.0.1'
+end

data/lib/rubeetup.rb

@@ -0,0 +1,140 @@
+require 'rubeetup/version'
+require 'rubeetup/utilities'
+require 'rubeetup/requests_catalog'
+require 'rubeetup/requester'
+require 'rubeetup/errors'
+require 'rubeetup/request_builder'
+require 'rubeetup/request'
+require 'rubeetup/request_sender'
+require 'rubeetup/request_response'
+require 'rubeetup/response_wrapper'
+
+##
+# @author Mike Vascelli <michele.vascelli@gmail.com>
+#
+# This module simplifies interaction with the Meetup.com API.
+# It gives you easy access to all of the available API methods, and it checks
+# 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
+#
+# Check out the names of the supported requests, and their respective
+# required arguments in +rubeetup/requests_lib/meetup_catalog.rb+, in the
+# MeetupCatalog documentation, or at: http://www.meetup.com/meetup_api/
+#
+# ==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 here http://www.meetup.com/Meetup-API-Testing for more information.
+#
+# ==Usage
+#   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
+#           .
+#           .
+#           .
+#     puts event.time
+#     puts event.duration
+#
+#     venue = event.venue
+#     puts venue[:address_1]
+#     puts venue[:city]
+#   end
+#
+#
+# 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
+#
+module Rubeetup
+  # Entry point to the Rubeetup client.
+  # It creates an object which handles all the requests for you.
+  # @param args [Hash{Symbol=>String}, nil] holds auth data to send with each request
+  # @option args [String] :key the api key
+  # @return [Rubeetup::Requester] the object which makes requests for the API user
+  #
+  def self.setup(args = nil)
+    agent.new(get_auth_data(args))
+  end
+
+  ##
+  # Sets up permanent default auth data.
+  # If on Rails, you could include this call in a new file: config/initializers/rubeetup.rb
+  # @param [Hash{Symbol=>String}] args holds auth data to send with each request
+  # @option args [String] :key the api key
+  # @return [nil]
+  #
+  def self.default_auth(args)
+    @auth_options = args
+    nil
+  end
+
+  class << self
+    private
+
+    def agent
+      @agent = Requester
+    end
+
+    # Trivial version
+    # @todo Should be modified to allow for tokens as well
+    #
+    def get_auth_data(args)
+      args || @auth_options
+    end
+  end
+end

data/rubeetup.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubeetup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubeetup'
+  spec.version       = Rubeetup::VERSION
+  spec.authors       = ['Mike Vascelli']
+  spec.email         = ['michele.vascelli@gmail.com']
+
+  spec.summary       = 'Ruby client library to the Meetup.com API'
+  spec.description   = "A comprehensive and easily extensible Ruby library \
+                       which simplifies interaction with the Meetup.com API"
+  spec.homepage      = 'https://github.com/mike-vascelli/rubeetup'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
+
+  spec.add_dependency 'multipart-post'
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: rubeetup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Vascelli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A comprehensive and easily extensible Ruby library                        which
+  simplifies interaction with the Meetup.com API
+email:
+- michele.vascelli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubeetup.rb
+- lib/rubeetup/errors.rb
+- lib/rubeetup/request.rb
+- lib/rubeetup/request_builder.rb
+- lib/rubeetup/request_response.rb
+- lib/rubeetup/request_sender.rb
+- lib/rubeetup/requester.rb
+- lib/rubeetup/requests_catalog.rb
+- lib/rubeetup/requests_lib/meetup_catalog.json
+- lib/rubeetup/requests_lib/meetup_catalog.rb
+- lib/rubeetup/response_wrapper.rb
+- lib/rubeetup/utilities.rb
+- lib/rubeetup/version.rb
+- rubeetup.gemspec
+homepage: https://github.com/mike-vascelli/rubeetup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client library to the Meetup.com API
+test_files: []
+has_rdoc: