rnvivo 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [Fernando Blat]
+
+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,43 @@
+# Nvivo API digester
+
+A small Ruby class for consuming [Nvivo API](http://www.nvivo.es/api/index.php).
+
+## Dependencies
+
+Just run `bundle install`.
+
+## How to use it
+
+Once you have your API Key, just initalize the client and run the methods you want:
+
+    nvivo = Rnvivo::Nvivo.new NVIVO_API_KEY
+    events = nvivo.cityGetEvents('Madrid')
+
+It returns an array of hashes with the name and the nvivo URL of each one:
+
+    'events' => {
+      'event' => [
+        {
+          'name' => 'Wadus event',
+          'url' => 'http://wadus.com/wadus-event'
+        },
+        {
+          'name' => 'Wadus event 2',
+          'url' => 'http://wadus.com/wadus-event-2'
+        }
+      ]
+    }
+
+Very simple.
+
+## TODO
+
+ - refactor, refactor, refactor
+
+## Special thanks
+
+- Sergio Arbeo [@serabe](https://twitter.com/serabe) for his PRs
+
+- Nvivo team. They are really nice!
+
+Copyright (c) 2009 [Fernando Blat](http://fernando.blat.es), released under the MIT license

data/lib/core_ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def blank?
+    self !~ /[^[:space:]]/
+  end
+end

data/lib/rnvivo.rb

@@ -0,0 +1,133 @@
+%w{rubygems httparty timeout}.each { |x| require x }
+
+require 'core_ext/string'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Rnvivo
+  class NvivoError < StandardError; end
+  class NvivoTimeoutError < NvivoError; end
+  class NvivoResultError < NvivoError
+    attr_reader :message
+    def initialize(message)
+      @message = message
+    end
+  end
+
+  class Nvivo
+    include HTTParty
+
+    API_URL = "http://www.nvivo.es/api/request.php"
+    format :xml
+    attr_reader :api_key, :timeout
+
+    def initialize(key, timeout = 30)
+      @api_key = key
+      @timeout = timeout
+    end
+
+    def cityGetEvents(city, country = 'all')
+      raise ArgumentError, 'You must indicate a city' if city.blank?
+
+      options = query 'city.getEvents',
+                      :city => city,
+                      :country_iso => country
+
+      deal_with_response_for options do |r|
+        return nested_result r, 'response', 'events', 'event'
+      end
+    end
+
+    def artistGetEvents(artist, country='all', past = false)
+      raise ArgumentError, 'You must indicate an artist' if artist.blank?
+
+      options = query 'artist.getEvents',
+                      :artist => artist,
+                      :county_iso => country,
+                      :past => past
+
+      deal_with_response_for options do |r|
+        return nested_result r, 'response', 'events', 'event'
+      end
+    end
+
+    def venueGetEvents(venue_id, past = false)
+      raise ArgumentError, 'You must indicate a venue' if venue_id.blank?
+
+      options = query 'venue.getEvents',
+                      :venue_id => venue_id,
+                      :past => past
+
+      deal_with_response_for options do |r|
+        return nested_result r, 'response', 'events', 'event'
+      end
+    end
+
+    def userGetEvents(user)
+      raise ArgumentError, 'You must indicate a user' if user.blank?
+
+      options = query 'user.getEvents',
+                      :user => user
+
+      deal_with_response_for(options) do |r|
+        return nested_result r, 'response', 'events', 'event'
+      end
+    end
+
+    def venueFind(venue_name, country='all')
+      raise ArgumentError, 'You must indicate a venue name' if venue_name.blank?
+
+      options = query 'venue.find',
+                      :venue_name => venue_name,
+                      :country_iso => country
+
+      deal_with_response_for options do |r|
+        return nested_result r, 'response', 'venues', 'venue'
+      end
+    end
+
+    def venueGet(venue_id)
+      raise ArgumentError, 'You must inidicate a venue id' if venue_id.blank?
+
+      options = query 'venue.get',
+                      :venue_id => venue_id
+
+      deal_with_response_for options do |r|
+        return nested_result r, 'response', 'venue'
+      end
+    end
+
+    protected
+
+    def query(method, *args)
+      {
+        query: args.first.merge({
+          method: method, api_key: @api_key
+        })
+      }
+    end
+
+    def nested_result(result, *args)
+      args.inject(result) do |memo, obj|
+        memo && memo[obj.to_s]
+      end || []
+    end
+
+    def deal_with_response_for(options, &block)
+      Timeout::timeout(@timeout) do
+        deal_with_result self.class.get(API_URL, options), &block
+      end
+    rescue Timeout::Error
+      raise NvivoTimeoutError
+    end
+
+    def deal_with_result(result)
+      if result['response']['status'] == 'success' && block_given?
+        return yield result
+      elsif result['response']['status'] == 'error'
+        return raise NvivoResultError.new(result['response']['error'])
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Rnvivo
+  VERSION = '1.0.0'
+end

data/test/nvivo/artistGetEvents_test.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"..","test_helper"))
+module Rnvivo
+
+  class ArtistGetEvents < MiniTest::Unit::TestCase
+    def test_artist_get_events_raises_nvivo_timeout_if_timeout
+      Nvivo.stubs(:get).raises(Timeout::Error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoTimeoutError do
+        response = n.artistGetEvents('Madrid', 'es')
+      end
+    end
+
+    def test_artist_get_events_should_get_artist_events
+      result_200_ok = {
+          'response' => {
+              'status' => 'success',
+              'events' => {
+                  'event' => [
+                      {
+                          'name' => 'Wadus event',
+                          'url' => 'http://wadus.com/wadus-event'
+                      },
+                      {
+                          'name' => 'Wadus event 2',
+                          'url' => 'http://wadus.com/wadus-event-2'
+                      }
+                  ]
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.artistGetEvents('Wadus artist')
+      assert_equal response, result_200_ok['response']['events']['event']
+    end
+
+    def test_artist_get_events_should_return_error
+      result_error = {
+          'response' => {
+              'status' => 'error',
+              'error'  => {
+                  'id' => 7,
+                  'message' => 'Error message'
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoResultError do
+        response = n.artistGetEvents('Wadus artist')
+      end
+    end
+
+    def test_artist_get_events_should_get_artist_events_emtpy
+      result_200_ok = {
+          'response' => {
+              'status' => 'success'
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.artistGetEvents('Madrid', 'es')
+      assert_equal response, []
+    end
+  end
+end

data/test/nvivo/cityGetEvents_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"..","test_helper"))
+
+module Rnvivo
+
+  class CityGetEvents < MiniTest::Unit::TestCase
+
+    def test_city_get_events_should_raise_nvivo_timeout_if_timeout
+      Nvivo.stubs(:get).raises(Timeout::Error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoTimeoutError do
+        response = n.cityGetEvents('Madrid', 'es')
+      end
+    end
+
+    def test_city_get_events_should_get_city_events_if_city_param
+      result_200_ok = {
+          'response' => {
+              'status' => 'success',
+              'events' => {
+                  'event' => [
+                      {
+                          'name' => 'Wadus event',
+                          'url' => 'http://wadus.com/wadus-event'
+                      },
+                      {
+                          'name' => 'Wadus event 2',
+                          'url' => 'http://wadus.com/wadus-event-2'
+                      }
+                  ]
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.cityGetEvents('Madrid', 'es')
+      assert_equal response, result_200_ok['response']['events']['event']
+    end
+
+    def test_city_get_events_should_get_city_events_emtpy
+      result_200_ok = {
+          'response' => {
+              'status' => 'success'
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.cityGetEvents('Madrid', 'es')
+      assert_equal response, []
+    end
+
+    def test_city_get_events_should_return_error
+      result_error = {
+          'response' => {
+              'status' => 'error',
+              'error'  => {
+                  'id' => 7,
+                  'message' => 'Error message'
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoResultError do
+        response = n.cityGetEvents('Madriz', 'es')
+      end
+    end
+  end
+end

data/test/nvivo/userGetEvents_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"..","test_helper"))
+
+module Rnvivo
+
+  class UserGetEvents < MiniTest::Unit::TestCase
+
+    def test_user_get_events_should_raise_nvivo_timeout_if_timeout
+      Nvivo.stubs(:get).raises(Timeout::Error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoTimeoutError do
+        response = n.userGetEvents('wadus')
+      end
+    end
+
+    def test_user_get_events_should_get_user_events_if_user_param
+      result_200_ok = {
+          'response' => {
+              'status' => 'success',
+              'events' => {
+                  'event' => [
+                      {
+                          'name' => 'Wadus event',
+                          'url' => 'http://wadus.com/wadus-event'
+                      },
+                      {
+                          'name' => 'Wadus event 2',
+                          'url' => 'http://wadus.com/wadus-event-2'
+                      }
+                  ]
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.userGetEvents('wadus')
+      assert_equal response, result_200_ok['response']['events']['event']
+    end
+
+    def test_user_get_events_should_get_user_events_emtpy
+      result_200_ok = {
+          'response' => {
+              'status' => 'success'
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.userGetEvents('wadus')
+      assert_equal response, []
+    end
+
+    def test_user_get_events_should_return_error
+      result_error = {
+          'response' => {
+              'status' => 'error',
+              'error'  => {
+                  'id' => 7,
+                  'message' => 'Error message'
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoResultError do
+        response = n.userGetEvents('wadus')
+      end
+    end
+  end
+end

data/test/nvivo/venueFind_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"..","test_helper"))
+
+module Rnvivo
+
+  class VenueFind < MiniTest::Unit::TestCase
+
+    def test_venue_find_should_raise_nvivo_timeout_if_timeout
+      Nvivo.stubs(:get).raises(Timeout::Error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoTimeoutError do
+        response = n.venueFind('Sala Wadus')
+      end
+    end
+
+    def test_venue_find_should_get_venues
+      result_200_ok = {
+          'response' => {
+              'status' => 'success',
+              'venues' => {
+                  'venue' => [
+                      {
+                          'name' => 'Wadus room',
+                          'url' => 'http://wadus.com/wadus-event'
+                      },
+                      {
+                          'name' => 'Sala Wadus',
+                          'url' => 'http://wadus.com/wadus-event-2'
+                      }
+                  ]
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.venueFind('Sala Wadus')
+      assert_equal response, result_200_ok['response']['venues']['venue']
+    end
+
+    def test_venue_find_should_get_emtpy_venues
+      result_200_ok = {
+          'response' => {
+              'status' => 'success'
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.venueFind('Sala Wadus')
+      assert_equal response, []
+    end
+
+    def test_venue_find_should_return_error
+      result_error = {
+          'response' => {
+              'status' => 'error',
+              'error'  => {
+                  'id' => 7,
+                  'message' => 'Error message'
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoResultError do
+        response = n.venueFind('Sala Wadus')
+      end
+    end
+  end
+end

data/test/nvivo/venueGetEvents_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"..","test_helper"))
+
+module Rnvivo
+
+  class VenueGetEvents < MiniTest::Unit::TestCase
+
+    def test_venue_get_events_should_raise_nvivo_timeout_if_timeout
+      Nvivo.stubs(:get).raises(Timeout::Error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoTimeoutError do
+        response = n.venueGetEvents('91')
+      end
+    end
+
+    def test_venue_get_events_should_get_venue_events_if_venue_names
+      result_200_ok = {
+          'response' => {
+              'status' => 'success',
+              'events' => {
+                  'event' => [
+                      {
+                          'name' => 'Wadus event',
+                          'url' => 'http://wadus.com/wadus-event'
+                      },
+                      {
+                          'name' => 'Wadus event 2',
+                          'url' => 'http://wadus.com/wadus-event-2'
+                      }
+                  ]
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.venueGetEvents('91')
+      assert_equal response, result_200_ok['response']['events']['event']
+    end
+
+    def test_venue_get_events_should_get_venue_events_emtpy
+      result_200_ok = {
+          'response' => {
+              'status' => 'success'
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.venueGetEvents('91')
+      assert_equal response, []
+    end
+
+    def test_venue_get_events_should_return_error
+      result_error = {
+          'response' => {
+              'status' => 'error',
+              'error'  => {
+                  'id' => 7,
+                  'message' => 'Error message'
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoResultError do
+        response = n.venueGetEvents('91')
+      end
+    end
+  end
+end

data/test/nvivo/venueGet_test.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.join(File.dirname(__FILE__),"..","test_helper"))
+
+module Rnvivo
+
+  class VenueGet < MiniTest::Unit::TestCase
+
+    def test_venue_get_should_raise_nvivo_timeout_if_timeout
+      Nvivo.stubs(:get).raises(Timeout::Error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoTimeoutError do
+        response = n.venueGet('Sala Wadus')
+      end
+    end
+
+    def test_venue_get_should_get_venues
+      result_200_ok = {
+          'response' => {
+              'status' => 'success',
+              'venue' => {
+                      'name' => 'Wadus room',
+                      'url' => 'http://wadus.com/wadus-event'
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.venueGet('91')
+      assert_equal response, result_200_ok['response']['venue']
+    end
+
+    def test_venue_get_should_get_emtpy_venues
+      result_200_ok = {
+          'response' => {
+              'status' => 'success'
+          }
+      }
+      Nvivo.stubs(:get).returns(result_200_ok)
+      n = Nvivo.new(FAKE_API_KEY)
+      response = n.venueGet('91')
+      assert_equal response, []
+    end
+
+    def test_venue_get_should_return_error
+      result_error = {
+          'response' => {
+              'status' => 'error',
+              'error'  => {
+                  'id' => 7,
+                  'message' => 'Error message'
+              }
+          }
+      }
+      Nvivo.stubs(:get).returns(result_error)
+      n = Nvivo.new(FAKE_API_KEY)
+      assert_raises NvivoResultError do
+        response = n.venueGet('91')
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/autorun'
+require File.expand_path(File.join(File.dirname(__FILE__), '/../lib/rnvivo'))
+require 'minitest/reporters'
+MiniTest::Reporters.use!
+require 'mocha/setup'
+
+FAKE_API_KEY = 'wadus'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rnvivo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Fernando Blat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Ruby library for the nvivo API
+email:
+- ferblape@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/core_ext/string.rb
+- lib/rnvivo.rb
+- lib/version.rb
+- test/nvivo/artistGetEvents_test.rb
+- test/nvivo/cityGetEvents_test.rb
+- test/nvivo/userGetEvents_test.rb
+- test/nvivo/venueFind_test.rb
+- test/nvivo/venueGet_test.rb
+- test/nvivo/venueGetEvents_test.rb
+- test/test_helper.rb
+- MIT-LICENSE
+- README.md
+homepage: http://github.com/ferblape/rnvivo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: nvivo API client in Ruby
+test_files: []