flyticket 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebe16a390b161010c474533890fd79070d7692fd
-  data.tar.gz: 6d89af551de944c107d317fc9d4a7260ad86bd19
+  metadata.gz: 186c7f03815762991f5fa89d04bea543912b8239
+  data.tar.gz: d6411ae46181b2a624e196f7d20f1772ca4968e5
 SHA512:
-  metadata.gz: 8cdd8cfcf64dd1f10ecdb8ca7a45b2099cd41b31770cb2a1906468b816dca8acf21c9e7fccfd01b95677933ca511c8aafe0a2c4b453aec7421c996cf38c48af4
-  data.tar.gz: 6509c26e0e2f052cb60eb6cb7c2d8aed54de058d649b03932f077b1c3672964877d9ae017f6aeba9a22aa332235e7435b90f0f982d7b7798a9528aed9e6863f1
+  metadata.gz: b099140a4f06e5d3b0806e268d374a28ab2f892c552cefa4eaeb8b2bd16ad71d3f388a0b97de291d06ae9f714473b5924546acc2b7a0fb69b9fa5eea8c899def
+  data.tar.gz: 8829e46170d8392537d74b54bcf690c1e8517e7d3fc70a9392ca05cc9a6582e78a338cd587ea4dfea8df3ae2487f9cfedda572cfcdee2640aba22a92f22cda28

data/README.md

@@ -3,62 +3,58 @@
 A Ruby gem for communicating with the [Ticketfly REST API](http://start.ticketfly.com/api/), built
 on [HTTParty](https://github.com/jnunemaker/httparty).
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'flyticket'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install flyticket
+I want to hear from you! Let me know if you're finding Flyticket useful, or if
+you have suggestions on what would make it useful for your project. I'm
+currently using it to develop a new website for a Ticketfly "org" so my use case
+is pretty narrow. I just wanted a nice wrapper for the API, and the gems I
+looked at were defunct.
 
 ## Example Usage
 
 Flyticket is still a work in progress, however, to query for events,
 use it like so:
 
+```ruby
+past = Flyticket::Events.past(venue_id: 1, max_results: 3)
+past.first.facebook_event_id  # --> FB event id for this venue's last show
 ```
-upcoming = Flyticket::Events.upcoming(venueId: 1, maxResults: 3)
-upcoming.first.venue.name  # --> 'Brooklyn Bowl'
 
-past = Flyticket::Events.past(venueId: 1, maxResults: 3)
-past.first.facebook_event_id  # --> FB event id for this venue's last show
+Flyticket is opinionated about the result format -- it discards Ticketfly's
+outer wrapper (used for pagination) and converts the top-level event hashes into
+OpenStructs, as well as the nested org and venue hashes, but leaves deeper
+properties as hashes. Thus retrieving a deeply-nested attributes looks like
+this:
+
+```ruby
+next_event = Flyticket::Events.upcoming(venue_id: 1, max_results: 1).first
+next_event.image[:medium][:width] # --> 'Brooklyn Bowl'
+
+upcoming = Flyticket::Events.upcoming(venue_id: 1, max_results: 3)
+upcoming.first.venue.name  # --> 'Brooklyn Bowl'
 ```
 
+Note how in the first example, `image` is a method, but deeper properties are
+accessed using hash keys. In the second example, because `venue` is a struct,
+the venue name can be accessed using a method (although `[:name]` works too]).
+
 #### Some useful properties:
-* orgId
-* venueId
-* eventId
-* maxResults (capped at 1000)
-* pageNum (required when total results > maxResults)
-* fromDate
-* thruDate
+* org_id
+* venue_id
+* event_id
+* max_results (capped by TicketFly at 1000)
+* page_num (use when total results > max_results)
+* from_date
+* thru_date
 
 ## Notes
 
-I haven't committed to an API just yet and won't attempt semantic versioning
-until I do.
+I haven't committed to an API just yet and won't attempt semantic versioning until I do.
 
 #### TODO
-* [ ] use snake case for options
-* [ ] handle error response
 * [ ] make original json available
 * [ ] handle fields & fieldGroup
 * [ ] specs
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/johncip/flyticket.

data/flyticket.gemspec

@@ -36,7 +36,6 @@ Gem::Specification.new do |spec|
   # racing stripes
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "pry-coolline", "~> 0.2"
-  spec.add_development_dependency "awesome_print", "~> 1.6"
 
   spec.add_runtime_dependency "plissken", "~> 0.2"
   spec.add_runtime_dependency "httparty", "~> 0.13"

data/lib/flyticket.rb

@@ -1,11 +1,11 @@
-require 'flyticket/version'
+require 'ostruct'
+
 require 'flyticket/events'
 require 'flyticket/venues'
 require 'flyticket/orgs'
+require 'flyticket/version'
 
-# Prevents returned JSON from being wrapped under a 'table' key.
-require 'ostruct'
-
+# Monkey-patch OStruct to prevent original JSON from being included.
 class OpenStruct
   def as_json(options = nil)
     @table.as_json(options)

data/lib/flyticket/Changelog.md

@@ -0,0 +1,11 @@
+### 0.1.2 / February 28, 2016
+
+* Add support for snake_case query arguments
+* Implement error class
+* Removed awesome_print from development dependencies
+* Add deep attribute example to readme
+* Added this changelog
+
+### 0.1.1 / February 7, 2016
+
+* Initial release

data/lib/flyticket/endpoint.rb

@@ -1,4 +1,3 @@
-# TODO: handle error response
 # TODO: handle fields & fieldGroup
 # TODO: make original response available
 # TODO: specs
@@ -7,26 +6,41 @@ require 'httparty'
 require 'ostruct'
 require 'plissken'
 
+require 'flyticket/ticketfly_error'
+require 'flyticket/util'
+
 module Flyticket
   class Endpoint
     include HTTParty
 
+    # Returns the key used to get the list of entries from Ticketfly's response.
     def self.key
       base_uri.split('/').last
     end
 
-    def self.get_many(fragment, query)
-      response = get fragment, query: query
+    # Gets a single event
+    def self.get_many(fragment, options)
+      response = get fragment, query: query_string(options)
+
+      handle_error(response)
       response[key].map { |hash| objectify(hash) }
     end
 
-    def self.get_one(fragment, query)
-      response = get fragment, query: query
+    # Gets a single event
+    def self.get_one(fragment, options)
+      response = get fragment, query: query_string(options)
+
+      handle_error(response)
       objectify response[key].first
     end
 
     private
 
+    # Camelcases the given options hash.
+    def self.query_string(options)
+      options.map { |k, v| [Util.camelize(k, false), v] }.to_h
+    end
+
     # Converts keys to snake case, then "semi-recursively" converts to OpenStruct.
     def self.objectify(hash)
       hash = hash.to_snake_keys
@@ -41,5 +55,12 @@ module Flyticket
       return unless hash.has_key? key
       hash[key] = OpenStruct.new(hash[key])
     end
+
+    # Raises an error if the response indicates a problem.
+    def self.handle_error
+      if response['status'] == 'error'
+        raise TicketflyError.new(response)
+      end
+    end
   end
 end

data/lib/flyticket/ticketfly_error.rb

@@ -0,0 +1,21 @@
+module Flyticket
+  class TicketflyError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def code
+      response['code']
+    end
+
+    def error_message
+      response['codeError']
+    end
+
+    def to_s
+      response.pretty_inspect
+    end
+  end
+end

data/lib/flyticket/util.rb

@@ -0,0 +1,12 @@
+module Flyticket
+  class Util
+    # Adapted an old version of ActiveSupport.
+    def self.camelize(term, first_letter_in_uppercase = true)
+      if first_letter_in_uppercase
+        term.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      else
+        term[0] + camelize(term)[1..-1]
+      end
+    end
+  end
+end

data/lib/flyticket/version.rb

@@ -1,3 +1,3 @@
 module Flyticket
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flyticket
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - John Cipriano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: plissken
   requirement: !ruby/object:Gem::Requirement
@@ -153,9 +139,12 @@ files:
 - bin/setup
 - flyticket.gemspec
 - lib/flyticket.rb
+- lib/flyticket/Changelog.md
 - lib/flyticket/endpoint.rb
 - lib/flyticket/events.rb
 - lib/flyticket/orgs.rb
+- lib/flyticket/ticketfly_error.rb
+- lib/flyticket/util.rb
 - lib/flyticket/venues.rb
 - lib/flyticket/version.rb
 homepage: https://github.com/johncip/flyticket