eventful_api 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+rdoc
+Gemfile.lock

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Tekin Suleyman.
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tekin Suleyman
+
+MIT License
+
+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,74 @@
+# EventfulApi
+
+[![Build Status](https://api.travis-ci.org/tekin/eventful_api.png)](http://travis-ci.org/tekin/eventful_api)
+
+## Description
+
+A Ruby library for accessing the eventful.com API. It supports
+their new OAuth authentication method.
+
+## Installation
+
+    gem install eventful_api
+
+## Configuration and usage
+
+The Eventful API requires authentication via [OAuth 1.0](http://tools.ietf.org/html/rfc5849) to access resources on
+behalf of Eventful users. You can register your application at
+[http://api.eventful.com/keys](http://api.eventful.com/keys). Once registered, you'll need to generate your
+OAuth consumer and secret.
+
+Configure `EventfulApi` with your application key, OAuth consumer key and your
+OAuth consumer secret:
+
+```ruby
+  EventfulApi.configure do |config|
+    config.application_key = YOUR_APPLICATION_KEY
+    config.consumer_key = YOUR_CONSUMER_KEY
+    config.consumer_secret = YOUR_CONSUMER_SECRET
+  end
+```
+
+You can make requests on behalf of a user once you have acquired their OAuth
+access token/secret pair by instantiating an `EventfulApi::Client`:
+
+```ruby
+  client = EventfulApi::Client.new(:oauth_token => 'token', :oauth_token_secret => 'token secret')
+
+  responsh_hash = client.post('/events/new', event_param_hash)
+  response_hash = client.get('/events/get', {:id => 'E0-001-053639493-9'})
+```
+
+EventfulApi makes requests to Eventful's JSON interface, returning the Hash equivalent of the JSON responses.
+
+## OAuth authentication
+
+You are free to acquire OAuth authorization from your users using your own process. However, EventfulApi does provide a
+convenient facade for generating both request tokens and access tokens.
+
+### Step 1. Requesting a token and redirect the user
+
+```ruby
+  request_token = EventfulApi.get_request_token(:oauth_callback => 'http://example.com/callback')
+  # store the request token and secret for later use and redirect the user
+  session[:request_token] = request_token.token
+  session[:request_secret] = request_token.secret
+  redirect_to token.redirect_url
+```
+
+### Step 2. Acquiring an access token during the callback
+
+```ruby
+  # Reconstruct the request token using the token and secret saved in the session
+  request_token = OAuth::RequstToken.new(EventfulApi.oauth_consumer, session[:request_token], session[:request_secret])
+  # Get an access token from Eventful using the oauth_verifier param
+  access_token = request_token.get_access_token(:oauth_verifier => params[:oauth_verifier])
+  # You now have a verified token and secret ready to create a client
+  client = EventfulApi::Client.new(:oauth_token => access_token.token, :oauth_secret => access_token.secret)
+```
+
+License
+-------
+Released under the MIT License. See the [LICENSE][license] file for further details.
+
+[license]: LICENSE.md

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+end
+
+task :default => ["test"]

data/eventful_api.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eventful_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "eventful_api"
+  gem.version       = EventfulApi::VERSION
+  gem.authors       = ["Tekin Suleyman"]
+  gem.email         = ["tekin@tekin.co.uk"]
+  gem.description   = %q{Ruby library for accessing the eventful.com API}
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/tekin/eventful_api"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency  "oauth", ["~> 0.3.6"]
+  gem.add_dependency  "multi_json", ["~> 1.5.0"]
+  gem.add_dependency  "addressable", ["~> 2.3.4"]
+
+  gem.add_development_dependency  "rake", ["~> 10.0.4"]
+  gem.add_development_dependency  "test-unit", ["~> 2.5.4"]
+  gem.add_development_dependency  "mocha", ["~> 0.13.2"]
+end

data/lib/eventful_api/client.rb

@@ -0,0 +1,39 @@
+require 'addressable/uri'
+require 'multi_json'
+
+module EventfulApi
+  class Client
+    API_URL = 'http://api.eventful.com'
+    attr_reader :access_token, :oauth_consumer
+
+    def initialize(params)
+      @oauth_consumer = OAuth::Consumer.new(EventfulApi.consumer_key, EventfulApi.consumer_secret, :site => API_URL, :scheme => EventfulApi::SCHEME)
+      @access_token = OAuth::AccessToken.new(oauth_consumer, params[:oauth_token], params[:oauth_secret])
+    end
+
+    def get(method, params)
+      response = access_token.get get_path(method, params)
+      MultiJson.load response.body
+    end
+
+    def post(method, params)
+      response = access_token.post(json_path(method), api_params(params))
+      MultiJson.load response.body
+    end
+
+    private
+
+    def get_path(path, params)
+      Addressable::URI.new(:path => json_path(path), :query_values => api_params(params)).to_s
+    end
+
+    def json_path(path)
+      "/json#{path}"
+    end
+
+    def api_params(params)
+      params.merge(:app_key => EventfulApi.app_key)
+    end
+  end
+end
+

data/lib/eventful_api/version.rb

@@ -0,0 +1,3 @@
+module EventfulApi
+  VERSION = "0.0.1"
+end

data/lib/eventful_api.rb

@@ -0,0 +1,29 @@
+require 'forwardable'
+require 'oauth'
+require 'eventful_api/client'
+require 'eventful_api/version'
+
+module EventfulApi
+  SITE_URL = 'http://eventful.com'
+  SCHEME = :query_string
+
+  @config = Struct.new(:consumer_key, :consumer_secret, :app_key).new
+
+  class << self
+    extend Forwardable
+
+    def_delegators :@config, :consumer_key, :consumer_secret, :app_key
+
+    def configure(&block)
+      yield @config
+    end
+
+    def oauth_consumer
+      @consumer ||= OAuth::Consumer.new(consumer_key, consumer_secret, :site => SITE_URL, :scheme => SCHEME)
+    end
+
+    def get_request_token(options)
+      oauth_consumer.get_request_token(options)
+    end
+  end
+end

data/test/test_client.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class TestEventfulApi < MiniTest::Unit::TestCase
+  def setup
+    EventfulApi.configure do |config|
+      config.consumer_key = 'key'
+      config.consumer_secret = 'secret'
+      config.app_key = 'app_key'
+    end
+  end
+
+  describe EventfulApi::Client do
+    before do
+      @client = EventfulApi::Client.new(:oauth_token => 'client_key', :oauth_secret => 'client_secret')
+    end
+
+    it 'has a oauth consumer for accessing the Eventful API' do
+      consumer = @client.oauth_consumer
+
+      assert consumer.is_a?(OAuth::Consumer)
+      assert_equal EventfulApi::Client::API_URL, consumer.site
+      assert_equal EventfulApi.consumer_key, consumer.key
+      assert_equal EventfulApi.consumer_secret, consumer.secret
+    end
+
+    it 'has an ouath access token' do
+      access_token = @client.access_token
+
+      assert access_token.is_a?(OAuth::AccessToken)
+      assert_equal 'client_key', access_token.token
+      assert_equal 'client_secret', access_token.secret
+      assert_equal @client.oauth_consumer, access_token.consumer
+    end
+
+    describe 'making a GET API call with parameters' do
+      it 'transforms the request and delegates the call through the access token' do
+        @client.access_token.expects(:get).with("/json/events/get?app_key=#{EventfulApi.app_key}&id=E0-001-053639493-9").returns(mock_response)
+        @client.get('/events/get', :id => 'E0-001-053639493-9')
+      end
+
+      it 'returns a hash representation of the response body' do
+        @client.access_token.expects(:get).with("/json/events/get?app_key=#{EventfulApi.app_key}&id=E0-001-054172192-4").returns(mock_response)
+        response = @client.get('/events/get', :id => 'E0-001-054172192-4')
+
+        assert_equal ({'foo' => 'bar'}), response
+      end
+    end
+
+    describe 'making a POST API call with parameters' do
+      it 'transforms the request and delegates the call through the access token' do
+        @client.access_token.expects(:post).with('/json/events/new', {:id => 'E0-001-053639493-9', :app_key => EventfulApi.app_key}).returns(mock_response)
+        response = @client.post('/events/new', :id => 'E0-001-053639493-9')
+      end
+
+      it 'returns a hash representation of the response body' do
+        @client.access_token.expects(:post).with('/json/events/new', {:id => 'E0-001-054172192-4', :app_key => EventfulApi.app_key}).returns(mock_response)
+        response = @client.post('/events/new', :id => 'E0-001-054172192-4')
+
+        assert_equal ({'foo' => 'bar'}), response
+      end
+    end
+
+    def mock_response
+      Struct.new(:body).new('{"foo": "bar"}')
+    end
+  end
+end

data/test/test_eventful_api.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class TestEventfulApi < MiniTest::Unit::TestCase
+
+  describe EventfulApi do
+    before do
+      EventfulApi.configure do |config|
+        config.consumer_key = 'key'
+        config.consumer_secret = 'secret'
+        config.app_key = 'app_key'
+      end
+    end
+
+    it 'has a consumer key' do
+      assert_equal 'key', EventfulApi.consumer_key
+    end
+
+    it 'has a consumer secret' do
+      assert_equal 'secret', EventfulApi.consumer_secret
+    end
+
+    it 'has an app key' do
+      assert_equal 'app_key', EventfulApi.app_key
+    end
+
+    it 'has an oauth consumer' do
+      consumer = EventfulApi.oauth_consumer
+
+      assert consumer.is_a?(OAuth::Consumer)
+      assert_equal EventfulApi.consumer_key,    consumer.key
+      assert_equal EventfulApi.consumer_secret, consumer.secret
+      assert_equal EventfulApi::SITE_URL,       consumer.site
+      assert_equal EventfulApi::SCHEME,         consumer.scheme
+    end
+
+    it 'delegates request token generation to its oauth consumer' do
+      options = { :callback_url => 'http://example.com/callback'}
+      EventfulApi.oauth_consumer.expects(:get_request_token).with(options).returns('token')
+
+      assert_equal 'token', EventfulApi.get_request_token(options)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'eventful_api'

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: eventful_api
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Tekin Suleyman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: addressable
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: mocha
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+    none: false
+  prerelease: false
+description: Ruby library for accessing the eventful.com API
+email:
+- tekin@tekin.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- eventful_api.gemspec
+- lib/eventful_api.rb
+- lib/eventful_api/client.rb
+- lib/eventful_api/version.rb
+- test/test_client.rb
+- test/test_eventful_api.rb
+- test/test_helper.rb
+homepage: http://github.com/tekin/eventful_api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2481929510141400674
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2481929510141400674
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby library for accessing the eventful.com API
+test_files:
+- test/test_client.rb
+- test/test_eventful_api.rb
+- test/test_helper.rb