tiqets 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac29b67471ebf800014817997928773e3bdc24e4
-  data.tar.gz: bef1664acb0ba4cb5d629e78900aaed38b2c025a
+  metadata.gz: 58a9128f0eeb3fe9c16aa58845a7e4b718cbd323
+  data.tar.gz: d4a69be377f0f1466f6b18820ba2d47c74d3f23e
 SHA512:
-  metadata.gz: b9b253f4b73bebdba922f294fbcfa8783d866dc2d7b1398f871bda2451ede7d216712cef716fbde1c93aaa109ab6d653b870caa8a8066d655fcd6cd7b28a7de4
-  data.tar.gz: c9709204cfd16e40ad63ff658b60dbaa79294eeda39157df7f5e35d504cb29648966e069daae9d439291d9b38cfb9ecfbd4be7b768e9c494f04c8eda7b4a20d6
+  metadata.gz: 5ca4a3bac7a153c4564ecf7caac312aa03d8592903bb11dd187bceeec7592adeac112df59dcd81b20fab685a5486563a2c234eb0aac1d22db719af317e784465
+  data.tar.gz: 598997ab957416a90145790dc88a5944c45e83a382819a6d04a3ddd7bff2e7e0969fd6d4b9750e37e161532a38afb64ddae78751b5d7a514a7482131b09e0ca2

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
+end

data/README.md

@@ -1,8 +1,12 @@
-# Tiqets
+# 🎢 Tiqets
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tiqets`. To experiment with that code, run `bin/console` for an interactive prompt.
+A simple (unofficial) Ruby wrapper for the [Tiqets](https://www.tiqets.com) [API](https://api.tiqets.com/v2/docs/).
 
-TODO: Delete this and the text above, and describe your gem
+[![Travis CI status](https://img.shields.io/travis/richardvenneman/tiqets.svg?style=flat-square)](https://travis-ci.org/richardvenneman/tiqets)
+[![RubyGem](https://img.shields.io/gem/v/tiqets.svg?style=flat-square)](https://rubygems.org/gems/tiqets)
+
+
+Full 100% API coverage is not a direct goal as we're primarily developing this for our needs at [CitySpotters](https://www.cityspotters.com). Pull requests are definitely welcome.
 
 ## Installation
 
@@ -22,7 +26,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You must be in possession of a Tiqets API key. Use this key to initialize a new API client:
+
+```ruby
+@client = Tiqets::Client.new(api_key: 'my-api-key')
+```
+
+Alternatively you can set the `TIQETS_API_KEY` environment variable and use the shared API instance with:
+
+```ruby
+@client = Tiqets.default_api
+```
+
+### Products
+
+#### Get a single product
+Finds a product by Product ID. Returns an object with the properties [described in the API documentation](https://api.tiqets.com/v2/docs/#the-product-object).
+
+```ruby
+@client.find_product(973698)
+# => #<Tiqets::Resources::Product::Product:0x007fe9c8438a00>
+```
 
 ## Contributing
 

data/lib/tiqets.rb

@@ -1,5 +1,11 @@
+require 'http'
+
 require 'tiqets/version'
+require 'tiqets/client'
+require 'tiqets/error'
 
 module Tiqets
-  # Your code goes here...
+  def self.default_api
+    @default_api ||= Client.new(api_key: ENV.fetch('TIQETS_API_KEY'))
+  end
 end

data/lib/tiqets/client.rb

@@ -0,0 +1,33 @@
+require 'addressable/uri'
+
+require 'tiqets/resources/product'
+
+module Tiqets
+  class Client
+    include Resources::Product
+
+    V2_ROOT = 'https://api.tiqets.com/v2/'.freeze
+
+    def initialize(root: V2_ROOT, api_key:)
+      @root = root
+      @api_key = api_key
+    end
+
+    def connection
+      @connection ||= HTTP.auth("Authorization: Token #{@api_key}")
+    end
+
+    def get(url, response_key)
+      response = connection.get(@root + url)
+
+      handle_response(response, response_key)
+    end
+
+    def handle_response(response, response_key)
+      response = JSON.parse(response)
+      return response[response_key] if response['success'] == true
+
+      raise Error.new(response['status'], response['message'])
+    end
+  end
+end

data/lib/tiqets/error.rb

@@ -0,0 +1,18 @@
+module Tiqets
+  class Error < Exception
+    attr_reader :code, :error
+
+    def initialize(code, error)
+      @code = code
+      @error = error
+
+      super(message)
+    end
+
+    def message
+      message = "Tiqets API Error: #{@error}"
+      message += " (code: #{@code})" unless @code.nil?
+      message
+    end
+  end
+end

data/lib/tiqets/resources/product.rb

@@ -0,0 +1,41 @@
+module Tiqets
+  module Resources
+    module Product
+      SLUG = 'products'.freeze
+
+      def find_product(id)
+        response = get("products/#{id}", 'product')
+        Product.new(response)
+      end
+
+      class Product
+        attr_reader :id, :language, :languages, :title, :tagline, :price,
+                    :sale_status, :country_name, :country_id, :city_name,
+                    :city_id, :tag_ids, :images, :ratings, :geolocation,
+                    :distance, :venue, :product_url, :product_checkout_url
+
+        def initialize(attributes)
+          @id = attributes['id']
+          @language = attributes['language']
+          @languages = attributes['languages']
+          @title = attributes['title']
+          @tagline = attributes['tagline']
+          @price = attributes['price']
+          @sale_status = attributes['sale_status']
+          @country_name = attributes['country_name']
+          @country_id = attributes['country_id']
+          @city_name = attributes['city_name']
+          @city_id = attributes['city_id']
+          @tag_ids = attributes['tag_ids']
+          @images = attributes['images']
+          @ratings = attributes['ratings']
+          @geolocation = attributes['geolocation']
+          @distance = attributes['distance']
+          @venue = attributes['venue']
+          @product_url = attributes['product_url']
+          @product_checkout_url = attributes['product_checkout_url']
+        end
+      end
+    end
+  end
+end

data/lib/tiqets/version.rb

@@ -1,3 +1,3 @@
 module Tiqets
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/tiqets.gemspec

@@ -20,7 +20,11 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'http', '~> 2'
+
   spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'guard', '~> 2'
+  spec.add_development_dependency 'guard-minitest', '~> 2'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiqets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Venneman
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.0'
 description: Ruby Tiqets API wrapper.
 email:
 - richardvenneman@me.com
@@ -63,12 +105,16 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/tiqets.rb
+- lib/tiqets/client.rb
+- lib/tiqets/error.rb
+- lib/tiqets/resources/product.rb
 - lib/tiqets/version.rb
 - tiqets.gemspec
 homepage: https://github.com/richardvenneman/tiqets