facebook_places 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed44bcbdf9157082b9014862aca284c3d0506754
+  data.tar.gz: 691b6fd44f7f4899f59c39edd47bb56d1e19da6a
+SHA512:
+  metadata.gz: 27faac1be0f55207240343436ceba0b9c511daf231112e1c3a7fc3e2b30b3c5babbd4fb728c7facc096a82aa76a7b4e46be0bc58daceae5d2c1596f087e1c6f1
+  data.tar.gz: 7efc223f95cf5022c2ac088a9a2efdb1e515d383b7dc971e29fc094b189dbd5cbfde6bd967e937cba76118f2bb4390b67e196de6684f17c65b9af2a041c8325f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version
+.ruby-gemset
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Documentation:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

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 mohamed.diaa27@gmail.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in facebook_places.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mohamed Diaa
+
+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,81 @@
+# FacebookPlaces
+
+[![Build Status](https://travis-ci.com/mohameddiaa27/facebook_places.svg?token=z3yXrVS4yVqTxaf5FPz7&branch=master)](https://travis-ci.com/mohameddiaa27/facebook_places)
+[![Code Climate](https://codeclimate.com/github/mohameddiaa27/facebook_places/badges/gpa.svg)](https://codeclimate.com/github/mohameddiaa27/facebook_places)
+[![Issue Count](https://codeclimate.com/github/mohameddiaa27/facebook_places/badges/issue_count.svg)](https://codeclimate.com/github/mohameddiaa27/facebook_places)
+[![Test Coverage](https://codeclimate.com/github/mohameddiaa27/facebook_places/badges/coverage.svg)](https://codeclimate.com/github/mohameddiaa27/facebook_places/coverage)
+
+This gem provides a Ruby wrapper around the [Facebook Places API](https://developers.facebook.com/docs/places/overview).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'facebook_places'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install facebook_places
+
+## Usage
+
+Initializing the Places Client by a token
+
+```ruby
+client = FacebookPlaces::Client.new(token)
+```
+
+### Places Search [Docs](https://developers.facebook.com/docs/places/web/search)
+With the Places Search API, you can search for millions of places worldwide, and retrieve place-related details like the number of checkins, ratings, and addresses—all with a single request. 
+
+```ruby
+results = client.search(options)
+```
+
+| option     | Description |
+|------------|-------------|
+| center     | The coordinates for the center of the search, in the format: [latitude],[longitude]; e.g., "140.7307,-73.9918".|
+| fields     | An array of [Place fields](https://developers.facebook.com/docs/places/fields) |
+| distance   | The maximum distance from the center, in meters. This parameter can only be used in conjunction with center. |
+| categories | The place categories to restrict the search results, e.g., ["FOOD_BEVERAGE"].|
+
+**Pagination**
+You can paginate through next pages of the search results by 
+
+```ruby
+new_results = results.next_page
+```
+
+### Place Information [Docs](https://developers.facebook.com/docs/places/web/place-information)
+The Places Information API allows your app to retrieve Place-related information. You can retrieve Place-related information using a place ID.
+
+```ruby
+place = client.find(place_id, fields: [])
+```
+| params     | Description |
+|------------|-------------|
+| place_id   | PLACE_ID    |
+| fields     | An array of [Place fields](https://developers.facebook.com/docs/places/fields) |
+
+
+## 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/mohameddiaa27/facebook_places. 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.
+
+
+## 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 'facebook_places'
+
+# 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/facebook_places.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facebook_places/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'facebook_places'
+  spec.version       = FacebookPlaces::VERSION
+  spec.authors       = ['Mohamed Diaa', 'Abanoub Aziz']
+  spec.email         = ['mohamed.diaa27@gmail.com', 'abanoub.aziz92@gmail.com']
+
+  spec.summary       = 'A simple wrapper for Facebook Places APIs'
+  spec.homepage      = 'https://github.com/mohameddiaa27/facebook_places'
+  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 'recursive-open-struct', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+  spec.add_development_dependency 'addressable', '~> 2.4.0'
+  spec.add_development_dependency 'webmock',     '~> 2.3'
+  spec.add_development_dependency 'vcr',         '~> 3.0'
+end

data/lib/facebook_places/client.rb

@@ -0,0 +1,32 @@
+module FacebookPlaces
+  class Client
+    ## Accessors
+    attr_accessor :access_token
+
+    ## Methods
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    # Search for place with place id
+    def find(place_id, fields: [])
+      options = {
+        fields: fields.join(','),
+        access_token: access_token
+      }
+      Place.find(place_id, options: options)
+    end
+
+    def search(center: '', q: '', distance: '', categories: [], fields: [])
+      options = {
+        q: q,
+        fields: fields.join(','),
+        center: center,
+        distance: distance,
+        'categories[]' => categories,
+        access_token: access_token
+      }
+      Place.search(options)
+    end
+  end
+end

data/lib/facebook_places/configuration.rb

@@ -0,0 +1,16 @@
+module FacebookPlaces
+  # Module including Gem Configuration
+  module Configuration
+    # BASE URLS
+    GRAPH_URL  = 'https://graph.facebook.com/'.freeze
+    VERSION    = 'v2.9'.freeze
+    BASE_URL   = GRAPH_URL + VERSION + '/'
+
+    # API URLS
+    PLACE_URL  = BASE_URL + '%{place_id}'
+    SEARCH_URL = BASE_URL + 'search'
+
+    # DEFAULT PARAMS
+    SEARCH_DEFAULT_ATTRIBUTES = { type: 'place' }.freeze
+  end
+end

data/lib/facebook_places/place.rb

@@ -0,0 +1,31 @@
+module FacebookPlaces
+  class Place
+    ## Class Methods
+    class << self
+      def find(id, options: {})
+        url     = Configuration::PLACE_URL % { place_id: id }
+        request = Request.new(url, options: options)
+        RecursiveOpenStruct.new(request.parsed_response, recurse_over_arrays: true)
+      end
+
+      def search(options)
+        options.merge! Configuration::SEARCH_DEFAULT_ATTRIBUTES
+        url          = Configuration::SEARCH_URL
+        request      = Request.new(url, options: options)
+        response     = RecursiveOpenStruct.new(request.parsed_response, recurse_over_arrays: true)
+        add_easy_pagination(response) unless response.dig(:paging, :next).nil?
+        response
+      end
+
+      private
+
+      def add_easy_pagination(response)
+        def response.next_page
+          uri = URI(paging.next)
+          options = CGI.parse(uri.query)
+          FacebookPlaces::Place.search(options)
+        end
+      end
+    end
+  end
+end

data/lib/facebook_places/request.rb

@@ -0,0 +1,38 @@
+module FacebookPlaces
+  class Request
+    ## Accessors
+    attr_accessor :response, :uri
+
+    ## Methods
+    def initialize(url, options: {})
+      options.delete_if { |_, value| value.to_s.strip == '' }
+      @uri       = URI(url)
+      @uri.query = URI.encode_www_form(options)
+      @response  = start!
+    end
+
+    def parsed_response
+      JSON.parse(response.body)
+    rescue
+      Logger.new(STDOUT).error 'Failed to Parse Response'
+    end
+
+    private
+
+    def start!
+      http_get do
+        return @response if @response.is_a?(Net::HTTPSuccess)
+        Logger.new(STDOUT).error parsed_response['error']['message']
+        raise StandardError
+      end
+    end
+
+    def http_get(&block)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        @request = Net::HTTP::Get.new uri
+        @response = http.request @request
+        yield
+      end
+    end
+  end
+end

data/lib/facebook_places/version.rb

@@ -0,0 +1,3 @@
+module FacebookPlaces
+  VERSION = '0.1.0'.freeze
+end

data/lib/facebook_places.rb

@@ -0,0 +1,13 @@
+require 'cgi'
+require 'json'
+require 'logger'
+require 'net/http'
+require 'facebook_places/version'
+require 'facebook_places/client'
+require 'facebook_places/configuration'
+require 'facebook_places/request'
+require 'facebook_places/place'
+require 'recursive-open-struct'
+
+module FacebookPlaces
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: facebook_places
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mohamed Diaa
+- Abanoub Aziz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- mohamed.diaa27@gmail.com
+- abanoub.aziz92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- facebook_places.gemspec
+- lib/facebook_places.rb
+- lib/facebook_places/client.rb
+- lib/facebook_places/configuration.rb
+- lib/facebook_places/place.rb
+- lib/facebook_places/request.rb
+- lib/facebook_places/version.rb
+homepage: https://github.com/mohameddiaa27/facebook_places
+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.10
+signing_key: 
+specification_version: 4
+summary: A simple wrapper for Facebook Places APIs
+test_files: []