yelp-fusion 0.1.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80658442d93d963e007622927ab89a7ac491147478d4f2ad58ccffff7a44ab05
+  data.tar.gz: 9c25f9f8fa8d95c53868b23f94153b7c82826783a1890f236286265598a56859
+SHA512:
+  metadata.gz: 5dff4e7d3367dc7ae44bec1c92f8aaf64cc9d1490276b23b2b35dc6f98a3c89924ab4055530b43e6b58e11801cc0a680e78222ed4717a38fc8d4ab009a93bfaa
+  data.tar.gz: addaae0328ee2601ed443175d3f653bcb925ae1a74f0fb220990d8d0f29c2a62532fe7b04a7c5b389ad565d5cf9e9f2038babf7008d612230428a15375e2d8f9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,210 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-06-20 16:01:59 -0400 using RuboCop version 0.57.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/CommentIndentation:
+  Exclude:
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/LeadingCommentSpace:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  Exclude:
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceBeforeComma:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+
+# Offense count: 23
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingBlankLines:
+  Enabled: false
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+
+# Offense count: 1
+Lint/InterpolationCheck:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+
+# Offense count: 6
+Metrics/AbcSize:
+  Max: 15
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 50
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 200
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 40
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/RangeInclude:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MaxKeyValuePairs.
+Performance/RedundantMerge:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+
+# Offense count: 21
+Style/Documentation:
+  Enabled: 
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/LineEndConcatenation:
+  Exclude:
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantParentheses:
+  Exclude:
+
+# Offense count: 19
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 80

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at egrueter@jobcase.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yelp-fusion.gemspec
+gemspec
+
+source 'https://rubygems.org'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jobcase, Inc
+
+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,180 @@
+# Yelp::Fusion
+
+This is a Ruby Gem for the Yelp API. It'll simplify the process of consuming data from the Yelp API for developers using Ruby. The library encompasses both Search and Business API functions.
+
+This library is in Beta and should be used for testing purposes only.
+
+Please remember to read and follow the [Terms of Use](https://www.yelp.com/developers/api_terms) and [display requirements](https://www.yelp.com/developers/display_requirements)before creating your applications.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yelp-fusion', require: 'yelp-fusion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yelp-fusion
+
+## Usage
+
+### Basic Usage
+
+The gem uses a client model to query against the API. You create and configure a client with your API keys and make requests through that.
+
+```ruby
+require 'yelp-fusion'
+
+client = Yelp::Fusion::Client.new(YOUR_API_KEY)
+```
+
+Alternatively, you can also globally configure the client using a configure
+block, and access a client singleton using `Yelp::Fusion.client`.  If you intend to
+use the gem with Rails, the client should be configured in an initializer.
+
+```ruby
+require 'yelp-fusion'
+
+configuration = Yelp.client.configure do |config|
+  config.api_key = YOUR_API_KEY
+end
+
+configuration.search('San Francisco', { term: 'food' })
+```
+After creating the client you're able to make requests to either the Search, Business, Phone, Review, Match, and Transaction API. Note: you must have an API key. If you need any keys sign up and get access from [http://www.yelp.com/developers](http://www.yelp.com/developers).
+
+### [Search API](https://www.yelp.com/developers/documentation/v3/business_search)
+
+Once you have a client you can use ``#search`` to make a request to the Search API.
+
+```ruby
+client.search('San Francisco')
+```
+
+You can also pass in general params and locale options to the method as hashes
+
+```ruby
+params = { term: 'food',
+           limit: 3,
+           category_filter: 'discgolf'
+         }
+
+locale = { lang: 'fr' }
+
+client.search('San Francisco', params, locale)
+```
+Key names and options for params and locale match the documented names on the [Yelp Search API](https://www.yelp.com/developers/documentation/v3/business_search)
+
+Additionally there is one more search methods for searching by [geographical coordinates](https://www.yelp.com/developers/documentation/v3/business_search):
+
+```ruby
+# coordinates
+coordinates = { latitude: 37.7577, longitude: -122.4376 }
+client.search_by_coordinates(coordinates, params)
+```
+
+### [Business API](https://www.yelp.com/developers/documentation/v3/business)
+
+To use the Business API after you have a client you just need to call ``#business`` with a business id
+
+```ruby
+client.business('lJAGnYzku5zSaLnQ_T6_GQ')
+```
+
+### [Phone Search API](https://www.yelp.com/developers/documentation/v3/business_search_phone)
+
+To use the Phone Search API after you have a client you just need to call ``#phone_search`` with a phone number and make sure you use the country code.
+
+```ruby
+client.phone_search('+15555555555')
+```
+
+### [Review Details API](https://www.yelp.com/developers/documentation/v3/business_reviews)
+
+To find all of the reviews for a business, use ``#review`` with a business ID. 
+
+```ruby
+client.review('lJAGnYzku5zSaLnQ_T6_GQ')
+```
+
+### [Transaction Details API](https://www.yelp.com/developers/documentation/v3/transaction_search)
+
+To find all of the reviews for a business, use ``#transaction`` with ``'deliver'`` and a business ID. 
+
+```ruby
+client.transaction_search('delivery', {location: 'San Francisco'})
+```
+
+### [Match Details API](https://www.yelp.com/developers/documentation/v3/business_match)
+
+To find all of the reviews for a business, use ``#match`` with a business ID. 
+
+```ruby
+client.match({name: 'swissbakers', address1: '168 Western Ave', city: 'allston', state: 'MA', country: 'US'})
+```
+
+## Responses
+
+Responses from the API are all parsed and converted into Ruby objects. You're able to access information using dot-notation
+
+```ruby
+## search
+response = client.search('San Francisco')
+
+response.businesses
+# [<Business 1>, <Business 2>, ...]
+
+response.businesses[0].name
+# "Kim Makoi, DC"
+
+response.businesses[0].rating
+# 5.0
+
+
+## business
+response = client.business('lJAGnYzku5zSaLnQ_T6_GQ')
+
+response.business.name
+# Yelp
+
+response.business.categories
+# [["Local Flavor", "localflavor"], ["Mass Media", "massmedia"]]
+```
+
+For specific response values check out the docs for the [Search API](http://www.yelp.com/developers/documentation/v2/search_api#rValue), the [Business API](http://www.yelp.com/developers/documentation/v2/business#rValue), the [Match API](https://www.yelp.com/developers/documentation/v3/business_match), the [Phone API](https://www.yelp.com/developers/documentation/v3/business_search_phone), the [Review API](https://www.yelp.com/developers/documentation/v3/business_reviews), and the [Transaction API](https://www.yelp.com/developers/documentation/v3/transaction_search)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/yelp-fusion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+1. Fork it ( http://github.com/yelp/yelp-ruby/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
+
+Our minitest test suite expects environment variables to be populated with your Yelp API Access Tokens.
+
+You can generate and find your Access Tokens at [https://www.yelp.com/developers/manage_api_keys](https://www.yelp.com/developers/v3/manage_app).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT), Copyright (c) 2018 Jobcase, Inc
+
+
+## Code of Conduct
+
+Everyone interacting in the Yelp::Fusion project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yelp-fusion/blob/master/CODE_OF_CONDUCT.md).