barrio-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbe857759b27e4d4f841f2838b1d025586b6660e
+  data.tar.gz: 607d93bceac6b6e60302d57496feaed6d7c5af0c
+SHA512:
+  metadata.gz: 41c6db3554d704c22d4b275eea4cfba7b0eecfcd8e870ffe11a8a7da93fcfdeb255982ace76829f48bd391ca74a8bac7fa140b9ebc0859ea02034e15400ec5f5
+  data.tar.gz: 0708e64b57a9e5d23edd80ade021e7de74a1bb49c7df465023cb91339fbe66599f4de387857bda4d8f9d58bd1a0f3845a169b232ebfbd1a688baa84da4f232d3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Grupo Barrio, Inc.
+
+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,94 @@
+# Barrio Client
+
+A ruby gem that makes it easy to access the [Barrio Platform API](http://www.barrio.mx/platform).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'barrio-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barrio-client
+
+## Usage
+
+Wherever you want to request data, include the library and create an instance of the client:
+
+```ruby
+require 'barrio-client'
+client = Barrio::Client.new('your-client_id-here')
+```
+
+You can get a client_id [here](http://www.barrio.mx/platform/client_id).
+
+Then you can query for information:
+
+```ruby
+locations = client.locations(:city => 'tijuana', :category => 'restaurant', :q => "kokopelli")
+
+puts locations.count                     # Result: 2
+
+puts locations.first.name                # Result: Tacos Kokopelli
+puts locations.first.location.address    # Result: Ave. Ocampo entre la 8va y 9na, Tijuana, Baja California
+puts locations.first.location.latitude   # 32.524164
+puts locations.first.location.longitude  # -117.030916
+
+locations.each do |l|
+    puts l.name
+end
+
+# Tacos Kokopelli
+# Foodgarden
+```
+
+### Functionality
+
+Four query methods are provided:
+
+```ruby
+# Search for locations using any of the supported filters or criteria
+locations = client.locations(:category => 'store', :city => 'ensenada')
+
+# Query for one specific location by Barrio ID
+location = client.location('barbacoa-el-corral-tijuana-mexico')
+
+# Find all the pictures for a specific location
+pictures = client.location_pictures('foodgarden-tijuana-mexico')
+puts pictures.last.url.large              # Result: https://www.filepicker.io/api/file/XRbqj4If...
+
+# Look up one specific picture by id
+picture = client.location_picture('foodgarden-tijuana-mexico', 1055)
+```
+
+### Supported Filters
+
+When using `client.locations` to search, there are many supported filters you can use.  They are all
+[documented here](http://www.barrio.mx/platform/docs/2151829540.html).
+
+Here are some examples:
+* `:sort`
+ * Change the sort order of results
+* `:q`
+ * Search for locations by keyword or text
+* `:lat`/`:lng`
+ * Search for locations near a certain latitude/longitude coordinate
+* `:category`
+ * Limit your search to one or more [categories](http://www.barrio.mx/platform/categories)
+* `:city`
+ * Limit your search to one [city](http://www.barrio.mx/platform/categories)
+* `:neighborhood`
+ * Limit your search to one [neighborhood](http://www.barrio.mx/platform/categories)
+
+There are many more filters available. This library supports everything supported by the Barrio.mx Platform API,
+so refer to the [API documentation](http://www.barrio.mx/platform/docs/2151829540.html) for a full list of available filters.
+
+### Help
+
+If you need help or have questions, check out the [documentation](http://www.barrio.mx/platform)
+or [contact us](http://www.barrio.mx/contact-us).

data/Rakefile

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

data/barrio-client.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barrio-client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "barrio-client"
+  gem.version       = Barrio::VERSION
+  gem.authors       = ["Barrio.mx"]
+  gem.email         = ["barrio@barrio.mx"]
+  gem.description   = %q{Ruby client library for accessing the Barrio.mx Platform API.}
+  gem.summary       = %q{See http://www.barrio.mx/platform for more information and documentation.}
+  gem.homepage      = "http://www.barrio.mx/platform"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  #Dependencies
+  gem.add_dependency('rocket_pants', '~> 1.0')
+end

data/lib/barrio-client.rb

@@ -0,0 +1,108 @@
+require "barrio-client/version"
+require 'rocket_pants'
+
+module Barrio
+  class Client < RocketPants::Client
+
+    version  1
+    base_uri 'http://platform.barrio.mx/'
+
+    attr_accessor :client_id
+
+    def initialize(client_id)
+      @client_id = client_id
+    end
+
+    class City < APISmith::Smash
+      property :id
+      property :name
+      property :localized_name
+    end
+
+    class Neighborhood < APISmith::Smash
+      property :id
+      property :name
+    end
+
+    class PhysicalLocation < APISmith::Smash
+      property :city, :transformer => City
+      property :neighborhood, :transformer => Neighborhood
+      property :address
+      property :latitude
+      property :longitude
+    end
+
+    class LocationRating < APISmith::Smash
+      property :average_rating
+      property :weighted_rating
+      property :number_of_reviews
+    end
+
+    class ContactInfo < APISmith::Smash
+      property :website
+      property :phone
+      property :phone_formatted
+    end
+
+    class User < APISmith::Smash
+      property :id
+      property :url
+      property :name
+    end
+
+    class PictureSizes < APISmith::Smash
+      property :small
+      property :medium
+      property :large
+    end
+
+    class Picture < APISmith::Smash
+      property :id
+      property :description
+      property :user, :transformer => User
+      property :url, :transformer => PictureSizes
+    end
+
+    class PictureInformation < APISmith::Smash
+      property :has_pictures
+      property :main_picture, :transformer => Picture
+    end
+
+    class Category < APISmith::Smash
+      property :id
+      property :name
+      property :localized_name
+      property :parent, :transformer => Category
+    end
+
+    class Location < APISmith::Smash
+      property :id
+      property :name
+      property :rating, :transformer => LocationRating
+      property :categories, :transformer => Category
+      property :location, :transformer => PhysicalLocation
+      property :contact, :transformer => ContactInfo
+      property :pictures, :transformer => PictureInformation
+      property :features
+      property :hours
+      property :closed_permanently
+    end
+
+    def locations(options = {})
+      get 'locations', :transformer => Location, :extra_query => options.merge(:client_id => client_id)
+    end
+
+    def location(id, options = {})
+      get "locations/#{id}", :transformer => Location, :extra_query => options.merge(:client_id => client_id)
+    end
+
+    def location_pictures(location_id, options = {})
+      get "locations/#{location_id}/pictures", :transformer => Picture, :extra_query => options.merge(:client_id => client_id)
+    end
+
+    def location_picture(location_id, picture_id, options = {})
+      get "locations/#{location_id}/pictures/#{picture_id}", :transformer => Picture, :extra_query => options.merge(:client_id => client_id)
+    end
+
+  end
+end

data/lib/barrio-client/version.rb

@@ -0,0 +1,3 @@
+module Barrio
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: barrio-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Barrio.mx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rocket_pants
+  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'
+description: Ruby client library for accessing the Barrio.mx Platform API.
+email:
+- barrio@barrio.mx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- barrio-client.gemspec
+- lib/barrio-client.rb
+- lib/barrio-client/version.rb
+homepage: http://www.barrio.mx/platform
+licenses: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: See http://www.barrio.mx/platform for more information and documentation.
+test_files: []