supreme_golf 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d8034d9b3c8a36628cab31faea0a239335ae566
+  data.tar.gz: 22a00ed433bd8fe552f8ca1a1769c619c07ed705
+SHA512:
+  metadata.gz: ac9c7a1f05359937d6931471152b1069a0536ea998d08b0a1d52f6949c225de9df28d35aa13dcc2c7ca6f89a7aad9714d957a8cde6bd99ca87bdfb5244f75642
+  data.tar.gz: 01047920917e098fcf81d1f03afdc0d9226861cad6cf90f8ccb9c54ac08c895f70f1e44ff7c0b58ea37c228f481affe2beb31ceb751265076502558830eb000c

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.swp
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kyle Peyton
+
+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,49 @@
+# SupremeGolf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'supreme-golf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install supreme-golf
+
+## Official docs
+
+    https://supremegolf.com/api/docs/
+
+## Usage
+
+The "params" passed to the API methods are simply the parameters defined in the official documentation listed above.
+
+    # Require the gem
+    require 'supreme_golf'
+
+    # Get all courses near a lat/lon
+    SupremeGolf::Course.near(params: {lat: 33.4677096, lon: -117.1318014, limit: 1})
+
+    # Get one course from an id
+    SupremeGolf::Course.find(3003)
+
+    # Get tee times for a course_id
+    SupremeGolf::TeeTime.at(3003)
+
+    # Get reservation url for a specific tee time for 2 people. Returning nil means invalid, returning string is reservation url
+    SupremeGolf::TeeTime.valid(30923902, params: {qty: 2})
+
+
+## Contributing
+
+You're welcome to contribute and help flesh out the rest of the API. I only implemented the methods I needed for my specific case, but there are many more you can see from the official docs.
+
+1. Fork it ( https://github.com/[my-github-username]/supreme-golf/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/supreme_golf/base.rb

@@ -0,0 +1,14 @@
+module SupremeGolf
+  class Base
+    def initialize attributes = {}
+      (self.class::ATTRS.map(&:to_s) & attributes.keys).each do |attr|
+        self.send("#{attr}=", attributes[attr])
+      end
+    end
+
+    def self.response_from_api url, params = {}
+      conn = Faraday.get url, params, SupremeGolf.configuration.http_headers
+      JSON.parse(conn.body)
+    end
+  end
+end

data/lib/supreme_golf/course.rb

@@ -0,0 +1,56 @@
+module SupremeGolf
+  class Course < SupremeGolf::Base
+    FIND_URL = "#{SupremeGolf::API_BASE_URL}/courses"
+    NEAR_URL = "#{SupremeGolf::API_BASE_URL}/courses/near"
+
+    ATTRS = [:id,
+      :slug,
+      :name,
+      :description,
+      :address_1,
+      :address_2,
+      :address_3,
+      :address_city,
+      :address_state,
+      :address_zipcode,
+      :address_country,
+      :phone,
+      :url,
+      :time_zone,
+      :latitude,
+      :longitude,
+      :rating,
+      :rounded_rating,
+      :rating_count,
+      :rough_tee_time_count,
+      :avg_rate,
+      :avg_regular_rate,
+      :min_rate,
+      :min_regular_rate,
+      :max_rate,
+      :max_regular_rate,
+      :distance,
+      :course_url,
+      :course_reviews_url,
+      :photo_thumb_url,
+      :photo_medium_url,
+      :photo_large_url
+    ]
+    attr_accessor *ATTRS
+
+    def self.find id
+      response = self.response_from_api "#{FIND_URL}/#{id}"
+
+      raise 'RecordNotFound' unless response['course']
+      new(response['course'])
+    end
+
+    def self.near params: {}
+      response = self.response_from_api NEAR_URL, params
+
+      response['courses'].map do |course_params|
+        new(course_params)
+      end
+    end
+  end
+end

data/lib/supreme_golf/tee_time.rb

@@ -0,0 +1,35 @@
+module SupremeGolf
+  class TeeTime < SupremeGolf::Base
+    AT_URL = "#{SupremeGolf::API_BASE_URL}/tee_times/at"
+    VALID_URL = "#{SupremeGolf::API_BASE_URL}/tee_times"
+
+    ATTRS = [:id,
+      :course_id,
+      :currency,
+      :players,
+      :rate,
+      :regular_rate,
+      :savings_pct,
+      :savings_amount,
+      :tee_off_at_formatted,
+      :tee_off_at_iso8601,
+      :amenities,
+      :provider
+    ]
+    attr_accessor *ATTRS
+
+    def self.at course_id, params: {}
+      response = self.response_from_api "#{AT_URL}/#{course_id}", params
+
+      response['tee_times'].map do |tee_time_params|
+        new(tee_time_params)
+      end
+    end
+
+    def self.valid id, params: {}
+      response = self.response_from_api "#{VALID_URL}/#{id}/valid", params
+
+      response['reservation_url']
+    end
+  end
+end

data/lib/supreme_golf/version.rb

@@ -0,0 +1,3 @@
+module SupremeGolf
+  VERSION = "0.0.2"
+end

data/lib/supreme_golf.rb

@@ -0,0 +1,37 @@
+require 'faraday'
+require 'json'
+
+module SupremeGolf
+  API_VERSION = 4
+  API_BASE_URL = "https://supremegolf.com:443/api/v#{API_VERSION}"
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :x_api_key
+
+    def initialize
+      @x_api_key = nil
+    end
+
+    def http_headers
+      headers = {}
+      headers['X-Api-Key'] = @x_api_key if @x_api_key
+      headers
+    end
+  end
+
+  configure
+end
+
+require 'supreme_golf/base'
+require 'supreme_golf/version'
+require 'supreme_golf/course'
+require 'supreme_golf/tee_time'

data/supreme_golf.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'supreme_golf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'supreme_golf'
+  spec.version       = SupremeGolf::VERSION
+  spec.authors       = ['Kyle Peyton']
+  spec.email         = ['kylepeyton@gmail.com']
+  spec.summary       = %q{Gem to wrap supremegolf.com API}
+  spec.description   = %q{Gem to wrap supremegolf.com API}
+  spec.homepage      = 'https://github.com/weexpectedTHIS/supreme_golf'
+  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.6'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'mocha'
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'json'
+end

data/test/fixtures/course_find.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://supremegolf.com/api/v4/courses/3002
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Vary:
+      - Accept-Encoding
+      - Origin
+      Status:
+      - 200 OK
+      X-Api-Version:
+      - 4.1.7
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 6922416c-dd74-4cc9-97d6-3a04c46aff47
+      X-Runtime:
+      - '0.011657'
+      X-Powered-By:
+      - Phusion Passenger 4.0.59
+      Date:
+      - Sun, 31 May 2015 04:17:22 GMT
+      Server:
+      - nginx + Phusion Passenger 4.0.59
+    body:
+      encoding: UTF-8
+      string: '{"course":{"id":3002,"slug":"temecula-creek-inn-oaks-course-california","name":"Temecula
+        Creek Inn - Oaks Course","description":"The 9-hole \"Oaks\" course at the
+        Temecula Creek Inn facility in Temecula, California features 3,436 yards of
+        golf from the longest tees for a par of 36. Designed by Ted Robinson, ASGCA,
+        the Oaks golf course opened in 1969.","address_1":"44501 Rainbow Canyon Rd","address_2":null,"address_3":null,"address_city":"Temecula","address_state":"CA","address_zipcode":"92592-5988","address_country":"United
+        States of America","phone":"855.685.9299","url":"http://www.temeculacreekinn.com/","time_zone":"America/Los_Angeles","latitude":33.46898,"longitude":-117.128529,"rating":3.0,"rounded_rating":3.0,"rating_count":3,"rough_tee_time_count":0,"avg_rate":"22.0","avg_regular_rate":"22.0","min_rate":"22.0","min_regular_rate":"22.0","max_rate":"22.0","max_regular_rate":"22.0","course_url":"https://supremegolf.com/tee-times/at/temecula-creek-inn-oaks-course-california","course_reviews_url":"https://supremegolf.com/tee-times/at/temecula-creek-inn-oaks-course-california/reviews","photo_thumb_url":"https://supremegolf.s3.amazonaws.com/assets/courses/3002/thumb.jpg?1420237939","photo_medium_url":"https://supremegolf.s3.amazonaws.com/assets/courses/3002/medium.jpg?1420237939","photo_large_url":"https://supremegolf.s3.amazonaws.com/assets/courses/3002/large.jpg?1420237939"}}'
+    http_version: 
+  recorded_at: Sun, 31 May 2015 04:17:22 GMT
+recorded_with: VCR 2.9.3