yelp-business 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f20c2c15c6eece9921105205aaf12e1aad62c131
+  data.tar.gz: 9044e250e8e97e14d52b5a02102f85fd00d7008f
+SHA512:
+  metadata.gz: bd178f739422a474c08a8aee6dd4f909d84943adc9318738fbeb24bc5b88c8a64ecdb41cd9e50c85b3828d1b3184a717cd3a6b48be9879bf88c67c5b1d88d01f
+  data.tar.gz: 338aa4bff75d1844c6e7390f3202c7914d005f3e0aa7dc0127ad4732f45eb0cce9f469be1350d72d7eda19efb85aa8bf5a627e19ebd9915cb798c669f75a46e5

data/.gitignore

@@ -0,0 +1,16 @@
+.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/doc/
+/pkg/
+/coverage/
+/spec/coverage/
+/tmp/
+/data
+/spec/coverage/
+/*.enc
+**/.DS_Store
+.ruby-version
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.travis.yml

@@ -0,0 +1,18 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=d17e91219ca5c271ca9bdd9eb447611f1be6b750abe8e4bc48146f5dec1154d4
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+  - 2.3.5
+before_install: gem install bundler -v 1.15.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Konstantin Gredeskoul
+
+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,90 @@
+[![Build Status](https://travis-ci.org/pioneerworks/yelp-business.svg?branch=master)](https://travis-ci.org/pioneerworks/yelp-business)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0ddd76e19c265107cd3e/maintainability)](https://codeclimate.com/github/pioneerworks/yelp-business/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0ddd76e19c265107cd3e/test_coverage)](https://codeclimate.com/github/pioneerworks/yelp-business/test_coverage)
+
+# Yelp::Business
+
+This is the simple data model encapsulating Yelp Business data received over [Fusion V3 API](https://www.yelp.com/developers/documentation/v3/business).
+
+## Usage
+
+### Configure
+
+First we need to configure the [access token](https://www.yelp.com/developers/documentation/v3/authentication):
+
+You can set the token either prorammatiacally (in ruby), or usin an external environment variable `YELP_ACCESS_TOKEN`.
+
+```bash
+export YELP_ACCESS_TOKEN='5eUZNOPOlWw9oQHowSKaYcWQK......'
+```
+
+Or, in ruby:
+
+```ruby
+# Set the token either directly on +Yelp+ module:
+Yelp.access_token = '5eUZNOPOlWw9oQHowSKaYcWQK....'
+
+# or using #configure method on Yelp::Business
+Yelp::Business.configure do |config|
+  config.access_token = token
+end
+```
+
+### Fetch Business Info
+
+Next, we'll fetch and cache business info. In your code, when you have business id or URL:
+
+```ruby
+require 'yelp/business'
+
+url  = 'https://www.yelp.com/biz/gary-danko-san-francisco'
+name = Yelp::Business.business_id_from(url) # => 'gary-danko-san-francisco'
+
+# initialize the object, and also fetch the data from Yelp
+business  = Yelp::Business.new(name).get
+
+# You can now call methods on the instance to access it's attributes:
+business.name   # => 'Gary Danko'
+business.rating #=> 4.5
+```
+
+You can also cache the results of the call:
+
+```ruby
+cache_key  = "yelp.business.#{business_id}"
+business   = Rails.cache.fetch(cache_key) do 
+  Yelp::Business.new(business_id).get
+end
+business.name #=> 'Gary Danko'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yelp-business'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yelp-business
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/pioneerworks/yelp-business](https://github.com/pioneerworks/yelp-business).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yelp/business"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/yelp-business

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH << lib_path if File.exist?(lib_path) && !$LOAD_PATH.include?(lib_path)
+
+require_relative '../lib/yelp/business'
+require 'colored2'
+
+if ARGV.empty?
+  puts 'usage: yelp-business <business_id>'
+  puts '   eg: yelp-business gary-danko-san-francisco'
+else
+  require 'awesome_print'
+  begin
+    ap Yelp::Business.new(ARGV.shift).get.data
+  rescue Yelp::MissingAccessTokenError
+    puts 'Error!'.bold.red + ' Set ' + 'YELP_ACCESS_TOKEN'.bold.blue + ' environment variable!'
+  end
+
+end

data/lib/yelp.rb

@@ -0,0 +1,24 @@
+require 'yelp/business/version'
+
+module Yelp
+  class BaseError < StandardError; end
+  class BusinessNotFoundError < BaseError; end
+  class InvalidIdentifierError < BaseError; end
+  class MissingAccessTokenError < BaseError; end
+  class YelpError < BaseError; end
+  class AuthenticationError < YelpError; end
+
+  API_HOST          = 'https://api.yelp.com'
+  BUSINESS_PATH     = '/v3/businesses/'
+  REVIEWS_SUFFIX    = '/reviews'
+  PUBLIC_URL_PREFIX = 'https://www.yelp.com/biz/'
+
+  class << self
+    attr_accessor :access_token
+  end
+
+  self.access_token ||= ENV['YELP_ACCESS_TOKEN']
+end
+
+
+require 'yelp/business'

data/lib/yelp/business.rb

@@ -0,0 +1,100 @@
+require 'ostruct'
+require 'json'
+require 'http'
+require 'colored2'
+
+require_relative '../yelp'
+
+module Yelp
+  class Business
+    class << self
+      def configure
+        Yelp.instance_eval do
+          yield(self)
+        end
+      end
+
+      def business_id_from(url)
+        url.gsub %r[.*/], ''
+      end
+    end
+
+    attr_accessor :data,
+      :business_url,
+      :business_id,
+      :api_url,
+      :reviews_api_url
+
+    def initialize(business_id = nil)
+      raise ::Yelp::InvalidIdentifierError, 'business ID can not be nil' if business_id.nil?
+      self.business_id  = business_id
+      self.business_url = PUBLIC_URL_PREFIX + business_id
+      self.api_url      = API_HOST + BUSINESS_PATH + self.business_id if self.business_id
+      self.reviews_api_url = API_HOST + BUSINESS_PATH + self.business_id + REVIEWS_SUFFIX
+    end
+
+
+    # usage: @business.fetch do |data|
+    #   data.name #=> 'Gary Danko'
+    # end
+    def fetch
+      unless self.data
+        raise ::Yelp::MissingAccessTokenError, 'please specify authentication token as class variable' unless access_token
+        self.data = OpenStruct.new(exec_api_call)
+        raise ::Yelp::BusinessNotFoundError "Can't find business #{business_id}" unless data
+      end
+      yield(self.data) if block_given?
+      self
+    end
+
+    alias get fetch
+
+    def get_reviews
+      self.data = OpenStruct.new(reviews_api_fetch)
+    end
+
+    def exec_api_call
+      raise ::Yelp::MissingAccessTokenError unless access_token
+      response = api_fetch
+      if response['error']
+        raise ::Yelp::AuthenticationError, 'Invalid access token' if response['error']['code'] == 'TOKEN_INVALID'
+        raise ::Yelp::BusinessNotFoundError, "Business #{business_id} was not found" if response['error']['description'] =~ /could not be found/
+        raise ::Yelp::YelpError, "Yelp returned error: #{response['error']['description']}"
+      end
+      response
+    rescue Exception => e
+      error "ERROR:   while fetching data for business #{business_id.bold.green} from #{api_url.yellow}"
+      error "DETAILS: #{e.message.bold.red}"
+      error(*e.backtrace) if ENV['DEBUG']
+      raise e
+    end
+
+    def error(*args)
+      STDERR.puts args.join("\n")
+    end
+
+    def api_fetch
+      HTTP.
+        auth(bearer_token).
+        get(api_url).parse
+    end
+
+    def reviews_api_fetch
+      HTTP.
+        auth(bearer_token).
+        get(reviews_api_url).parse
+    end
+
+    def bearer_token
+      "Bearer #{access_token}"
+    end
+
+    def access_token
+      Yelp.access_token
+    end
+
+    def method_missing(method, *args, &block)
+      data.send(method, *args, &block)
+    end
+  end
+end

data/lib/yelp/business/version.rb

@@ -0,0 +1,5 @@
+module Yelp
+  class Business
+    VERSION = "0.2.1"
+  end
+end

data/yelp-business.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yelp/business/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yelp-business'
+  spec.version       = Yelp::Business::VERSION
+  spec.authors       = ['Konstantin Gredeskoul', 'Tim Cannady', 'Pioneerworks, Inc']
+  spec.email         = %w(kigster@gmail.com tim@joinhomebase.com)
+
+  spec.summary       = 'Provides and easy to use model wrapping Yelp Business'
+  spec.description   = 'Provides and easy to use model wrapping Yelp Business'
+
+  spec.homepage      = 'https://github.com/pioneerworks/yelp-business'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'http'
+  spec.add_dependency 'colored2'
+  spec.add_dependency 'awesome_print'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'irbtools'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: yelp-business
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+- Tim Cannady
+- Pioneerworks, Inc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  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'
+- !ruby/object:Gem::Dependency
+  name: colored2
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+- !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: simplecov
+  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: irbtools
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+description: Provides and easy to use model wrapping Yelp Business
+email:
+- kigster@gmail.com
+- tim@joinhomebase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/yelp-business
+- lib/yelp.rb
+- lib/yelp/business.rb
+- lib/yelp/business/version.rb
+- yelp-business.gemspec
+homepage: https://github.com/pioneerworks/yelp-business
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Provides and easy to use model wrapping Yelp Business
+test_files: []