zvents 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18b57a5c9e9a710a1827b877d1a9815348ee801e
+  data.tar.gz: 77900949e0f5d0b7d1d29123fb7f709cbb609421
+SHA512:
+  metadata.gz: a29ae1efa37cca7e5f97dbfa14745a2584e3d9ec1f4b16e99fb0b726ee34f746ff07c3f9260154bd4a2f9718fdf91ec526d86c8610507ed7d42d8f3fcabf932f
+  data.tar.gz: 6a7fbd23d3ab397253d327e31c99aa14cad44134ecdb5762a8090419c907f3d156587b40288b8a6e0b711227911eb484f6709ee43f8dc1d652c304897c0c1d74

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+--require spec_helper
+--pattern "spec/**/*_spec.rb"

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - jruby-19mode

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0
+  - Search API endpoint
+  - Event find by id endpoint implemented
+  - Venue find by id endpoint implemented

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Austin Fonacier
+
+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,84 @@
+# Zvents
+
+[![Code Climate](https://codeclimate.com/github/austinrfnd/zvents.png)](https://codeclimate.com/github/austinrfnd/zvents)
+
+This is a ruby wrapper around the Zvents API.  This is a replacement for the old Zvents-Gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zvents'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zvents
+
+## Usage
+
+
+```ruby
+
+# set api key
+Zvents::Event.api_key '123'
+
+# Finding an event
+event = Zvents::Event.find('event_id')
+
+# Finding the venue of an eventt
+event = Zvents::Event.find('event_id')
+venue = event.venue
+
+# Finding a venue
+venue = Zvents::Venue.find('venue_id')
+
+# Searching
+search_results = Zvents.search('search parameters')
+### search parameters are what, where, when, radius, limit, offset, spn_limit,
+### cat, has_kids, city, neighborhood. trim. has_ticket, sequence
+ex:
+search_results = Zvents.search({where: "San Francisco"})
+events = search_results.events
+venues = search_results.venues
+
+# what = parameters[:what] e.g. "parade"
+# where = parameters[:where] e.g. "San Francisco", "94131",
+#   "-74.0BY:40.9" (Latitude by longitude), "California"
+# when = parameters[:when] e.g. "monday to thursday",
+#   "10/30/2007 to 11/4/2007"
+# radius = parameters[:radius]
+#   (number of miles around where field to search)
+# limit = parameters[:limit] (max number of items to return)
+# offset = parameters[:offset] (number of items to skip from
+#   beginning of the search results)
+# spn_limit = parameters[:spn_limit] (max number of sponsored
+#   items to return)
+# cat = parameters[:cat] (restrict your search to a specific
+#   category)
+# has_kids = parameters[:has_kids] (1 or 0.
+#   1 means kid friendly. Events only)
+# city = parameters[:city]
+# neighborhood = parameters[:neighborhood]
+# trim = parameters[:trim] (0 or 1. 1 trims repeat events.
+#   default = 1)
+# has_tickets = parameters[:has_tickets] (0 or 1. 1 retuns
+#   only events with tickets for sale)
+# sequence = parameters[:sequence] (restrict search to events
+#   within a sequence. Multiple sequence ids can be provided
+#   separated by a comma)
+
+
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/zvents/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => :spec

data/lib/zvents/configuration.rb

@@ -0,0 +1,13 @@
+module Zvents
+  def self.configure
+    yield self
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+  
+  def self.api_key
+      @@api_key
+  end
+end

data/lib/zvents/connection.rb

@@ -0,0 +1,10 @@
+module Zvents
+    def self.connection
+        @connection ||= Faraday.new(url: 'http://www.zvents.com/') do |faraday|
+            faraday.request  :url_encoded             # form-encode POST params
+            faraday.response :logger                  # log requests to STDOUT
+            faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+            faraday.response :json
+        end        
+    end
+end

data/lib/zvents/errors.rb

@@ -0,0 +1,10 @@
+module Zvents
+    class EventNotFoundError < StandardError
+    end
+    
+    class VenueNotFoundError < StandardError
+    end
+
+    class SearchError < StandardError
+    end
+end

data/lib/zvents/event.rb

@@ -0,0 +1,50 @@
+module Zvents
+    class Event
+        require 'zvents/venue'
+        include Virtus.model
+
+        RESOURCE_URL = '/partner_rest/event'
+
+        attribute :avg_ratings, Array
+        attribute :categories, Array
+        attribute :creator, String
+        attribute :description, String
+        attribute :endtime, String
+        attribute :external_urls, Array
+        attribute :id, Integer
+        attribute :images, Array
+        attribute :link, String
+        attribute :name, String
+        attribute :parent_id, Integer
+        attribute :performers, Array
+        attribute :phone, String
+        attribute :price, String
+        attribute :recurrences, Array
+        attribute :sponsored_data, Array
+        attribute :starttime, String
+        attribute :summary, String
+        attribute :tags, Array
+        attribute :url, String
+        attribute :venue, Venue
+        attribute :venue_id, Integer
+
+        # Zvent::Event.find('123123') => an instance of an event
+        #
+        def self.find(id)
+            parameters = {id: id}
+            response = Zvents.find(RESOURCE_URL, parameters)
+
+            if response.body['rsp']['status'] != 'ok'
+                raise Zvents::EventNotFoundError.new("could not find event with id #{id}")
+            end
+            venue_hash = {venue: response.body['rsp']['content']['venues'].first}
+            self.new(response.body['rsp']['content']['events'].first.merge(venue_hash))
+        end
+
+        # venue() => an instance of the venue where the event takes place
+        #
+        def venue
+            @venue ||= Zvents::Venue.find(@venue_id)
+        end
+    end
+end

data/lib/zvents/search_results.rb

@@ -0,0 +1,20 @@
+module Zvents
+    class SearchResults
+        require 'zvents/event'
+        require 'zvents/venue'
+        include Virtus.model
+
+        attribute :events, Array[Event]
+        attribute :venues, Array[Venue]
+
+        def events
+            unless @venues_initialized
+                @events.each do |event|
+                    event.venue = @venues.detect{|venue| venue.id == event.venue_id}
+                end
+            end
+            @venues_initialized = true
+            @events
+        end
+    end
+end

data/lib/zvents/venue.rb

@@ -0,0 +1,40 @@
+module Zvents
+    class Venue
+        include Virtus.model
+        
+        RESOURCE_URL = '/partner_rest/venue'
+
+        attribute :address, String
+        attribute :avg_ratings, Array
+        attribute :city, String
+        attribute :country, String
+        attribute :creator, String
+        attribute :description, String
+        attribute :external_urls, Array
+        attribute :id, Integer
+        attribute :images, Array
+        attribute :latitude, Float
+        attribute :link, String
+        attribute :longitude
+        attribute :name, String
+        attribute :neighborhood, String
+        attribute :parent_id, Integer
+        attribute :phone, String
+        attribute :state, String
+        attribute :tags, Array
+        attribute :url, String
+        attribute :zipcode, String
+        
+        # Zvent::Venue.find('123123') => an instance of a venue
+        # 
+        def self.find(id)
+            parameters = {id: id}
+            response = Zvents.find(RESOURCE_URL, parameters)
+            
+            if response.body['rsp']['status'] != 'ok'
+                raise Zvents::VenueNotFoundError.new("could not find venue with id #{id}") 
+            end
+            self.new(response.body['rsp']['content']['venues'].first)
+        end
+    end
+end

data/lib/zvents/version.rb

@@ -0,0 +1,3 @@
+module Zvents
+  VERSION = "0.1.0"
+end

data/lib/zvents.rb

@@ -0,0 +1,61 @@
+require "zvents/version"
+require "zvents/configuration"
+require 'zvents/connection'
+require 'zvents/errors'
+require 'virtus'
+require 'faraday'
+require 'faraday_middleware'
+require 'zvents/event'
+require 'zvents/venue'
+require 'zvents/search_results'
+
+module Zvents
+    # Zvents.search(parameters) => an instance of SearchResults
+    #
+    # can search by these parameters 
+    # what = parameters[:what] e.g. "parade"
+    # where = parameters[:where] e.g. "San Francisco", "94131", 
+    #   "-74.0BY:40.9" (Latitude by longitude), "California"
+    # when = parameters[:when] e.g. "monday to thursday",
+    #   "10/30/2007 to 11/4/2007"
+    # radius = parameters[:radius] 
+    #   (number of miles around where field to search)
+    # limit = parameters[:limit] (max number of items to return)
+    # offset = parameters[:offset] (number of items to skip from
+    #   beginning of the search results)
+    # spn_limit = parameters[:spn_limit] (max number of sponsored
+    #   items to return)
+    # cat = parameters[:cat] (restrict your search to a specific
+    #   category)
+    # has_kids = parameters[:has_kids] (1 or 0. 
+    #   1 means kid friendly. Events only)
+    # city = parameters[:city]
+    # neighborhood = parameters[:neighborhood]
+    # trim = parameters[:trim] (0 or 1. 1 trims repeat events.
+    #   default = 1)
+    # has_tickets = parameters[:has_tickets] (0 or 1. 1 retuns
+    #   only events with tickets for sale)
+    # sequence = parameters[:sequence] (restrict search to events
+    #   within a sequence. Multiple sequence ids can be provided
+    #   separated by a comma)
+      
+    def self.search(parameters = {})
+        resource_url = "/partner_rest/search"
+        response = find(resource_url, parameters)
+        if response.body['rsp']['status'] != 'ok'
+              raise Zvents::SearchError.new("search failed") 
+        end
+        search_hash = response.body['rsp']['content']
+        SearchResults.new(search_hash)
+     end
+
+     private 
+     def self.find(url, parameters = {})
+          connection.get do |req|
+                req.url url
+                req.params['key'] = api_key
+                req.params['format'] = 'json'
+                req.params.merge!(parameters)
+          end
+     end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,6 @@
+describe "Zvents Configuration" do
+  it "should return self on .configure" do
+      pending
+    expect(Zvents.configure).to be_kind_of(Zvents)
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,39 @@
+describe "Event" do
+    describe "initialize" do
+        it "should initialize with some attributes" do
+            event = Zvents::Event.new({creator: 'Austin Fonacier'})
+            expect(event.creator).to eql("Austin Fonacier")
+        end # rake
+        it "should be able to create a venue for the event" do
+            event = Zvents::Event.new({id: '123', name: 'my_event', venue_id: "1",
+                                       venue: {id: '1', name: 'venue_name'}})
+            expect(event.venue).to be_kind_of(Zvents::Venue)
+            expect(event.venue.id).to eq(1)
+        end
+    end
+    
+    describe 'self.find' do
+        before :each do
+            Zvents.api_key = ENV['ZVENT_API_KEY']
+        end
+        it "should return a new event instance" do
+            event = Zvents::Event.find(370741694)
+            expect(event).to be_kind_of(Zvents::Event)
+        end
+        
+        it "should throw an error if no event can be found" do
+            expect {
+                Zvents::Event.find('bad_id')
+            }.to raise_error(Zvents::EventNotFoundError)
+        end
+    end
+    describe 'venue' do
+        before :each do
+            Zvents.api_key = ENV['ZVENT_API_KEY']
+        end
+        it "should return a new event instance" do
+            event = Zvents::Event.find(370741694)
+            expect(event.venue).to be_kind_of(Zvents::Venue)
+        end
+    end   
+end

data/spec/search_results_spec.rb

@@ -0,0 +1,8 @@
+describe "SearchResults" do
+    describe "initialize" do
+        it "should initialize with some attributes" do
+            search_results = Zvents::SearchResults.new({events: [{creator: 'Austin Fonacier'}]})
+            expect(search_results.events.first.creator).to eql("Austin Fonacier")
+        end # rake
+    end
+end

data/spec/search_spec.rb

@@ -0,0 +1,17 @@
+describe "Search" do
+    describe "search" do
+        before :each do
+            Zvents.api_key = ENV['ZVENT_API_KEY']
+        end
+        it "should search by some parameters and return a new search results instance" do
+            search = Zvents.search({where: 'San Franciso'})
+            expect(search).to be_kind_of(Zvents::SearchResults)
+        end # rake
+        it "should initialize the venues for the events if it can" do
+            search = Zvents.search({where: 'San Francisco'})
+            search.events.each do |event|
+                expect(event.venue.id).to eq(event.venue_id)
+            end
+        end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'zvents'
+

data/spec/venue_spec.rb

@@ -0,0 +1,24 @@
+describe "Venue" do
+    describe "initialize" do
+        it "should initialize with some attributes" do
+            venue = Zvents::Venue.new({creator: 'Austin Fonacier'})
+            expect(venue.creator).to eql("Austin Fonacier")
+        end # rake
+    end
+    
+    describe 'self.find' do
+        before :each do
+            Zvents.api_key = ENV['ZVENT_API_KEY']
+        end
+        it "should return a new venue instance" do
+            venue = Zvents::Venue.find(17369152)
+            expect(venue).to be_kind_of(Zvents::Venue)
+        end
+        
+        it "should throw an error if no venue can be found" do
+            expect {
+                Zvents::Venue.find('bad_id')
+            }.to raise_error(Zvents::VenueNotFoundError)
+        end
+    end
+end

data/zvents.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zvents/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zvents"
+  spec.version       = Zvents::VERSION
+  spec.authors       = ["Austin Fonacier", 'Eric Kuecks']
+  spec.email         = ["austinrf@gmail.com", 'ekuecks@ucla.edu']
+  spec.summary       = "Ruby wrapper for the Zvents API"
+  spec.description   = "Ruby wrapper for the Zvents API"
+  spec.homepage      = "http://github.com/austinrfnd/zvents"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 3.0.0.beta2'
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'virtus', '~> 1.0.2'
+  spec.add_dependency 'faraday_middleware'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: zvents
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Austin Fonacier
+- Eric Kuecks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: Ruby wrapper for the Zvents API
+email:
+- austinrf@gmail.com
+- ekuecks@ucla.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zvents.rb
+- lib/zvents/configuration.rb
+- lib/zvents/connection.rb
+- lib/zvents/errors.rb
+- lib/zvents/event.rb
+- lib/zvents/search_results.rb
+- lib/zvents/venue.rb
+- lib/zvents/version.rb
+- spec/configuration_spec.rb
+- spec/event_spec.rb
+- spec/search_results_spec.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+- spec/venue_spec.rb
+- zvents.gemspec
+homepage: http://github.com/austinrfnd/zvents
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Zvents API
+test_files:
+- spec/configuration_spec.rb
+- spec/event_spec.rb
+- spec/search_results_spec.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+- spec/venue_spec.rb