threetaps_client 0.0.2

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 threetaps_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phong Nguyen
+
+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,64 @@
+# ThreetapsClient
+
+A very simple Rest Client for 3taps API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'threetaps_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install threetaps_client
+
+## Usage
+
+Setup API key:
+
+    ThreetapsClient.api_key = <your-api-key>
+
+Use Search API:
+
+    ThreetapsClient.search :source => 'CRAIG', :location => { :country => 'USA' }
+
+Use Polling API:
+
+    # To start polling from a given point in time
+    ThreetapsClient.anchor Time.now.to_i
+
+    # Retrieves a set of new postings from the database
+    ThreetapsClient.poll
+    ThreetapsClient.poll(640587080)
+    ThreetapsClient.poll('640587080')
+    ThreetapsClient.poll :anchor => '640587080', :source => 'CRAIG', :location => { :country => 'USA' }
+
+Use Reference API:
+
+    # To obtain a list of data sources
+    ThreetapsClient.data_sources
+
+    # To obtain a list of category groups
+    ThreetapsClient.category_groups
+
+    # To obtain a list of categories
+    ThreetapsClient.categories
+
+    # To obtain a list of locations by level
+    # level can be 'country'|'state'|'metro'|'region'|'county'|'city'|'locality'|'zipcode'
+    ThreetapsClient.locations(level) 
+
+    # The find the details of a single location based on its 3taps location code
+    ThreetapsClient.lookup_location(code)
+
+## Contributing
+
+1. Fork it ( http://github.com/phongnh/threetaps_client/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

data/Rakefile

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

data/lib/threetaps_client/core_ext/array.rb

@@ -0,0 +1,7 @@
+return if {}.respond_to?(:extract_options!)
+
+class Array
+  def extract_options!
+    self.last.is_a?(Hash) ? self.pop : {}
+  end
+end

data/lib/threetaps_client/core_ext/hash.rb

@@ -0,0 +1,25 @@
+class Hash
+  # Returns a "flatten" hash representation of the receiver:
+  #
+  #   { :source => 'CRAIG', :location => { :country => 'USA' } }.flatten
+  #   # => { :source => 'CRAIG', :"location.country" => 'USA' }
+  #
+  #   { :param => 1, :nested => { :param => 2, :nested => { :param => 2 } } }.flatten
+  #   # => { :param => 1, :"nested.param" => 2, :"nested.nested.param" => 2}
+  #
+  # An optional prefix can be passed to enclose the key names:
+  #
+  #   { :country => 'USA', :state => 'CA' }.flatten('location')
+  #   # => { :"location.country" => 'USA', :"location.state" => 'CA' }
+  def flatten(prefix=nil)
+    prefix = "#{prefix}." if prefix
+    inject({}) do |hash, (key, value)|
+      if value.is_a?(Hash)
+        hash.merge! value.flatten("#{prefix}#{key}")
+      else
+        hash[:"#{prefix}#{key}"] = value
+      end
+      hash
+    end
+  end
+end

data/lib/threetaps_client/core_ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  # Parses a JSON string (JavaScript Object Notation) into a hash.
+  #
+  #   "{\"success\":true,\"anchor\":640503449}".decode_json
+  #   # => { "success": true, "anchor":640503449 }
+  def decode_json
+    JSON(self)
+  end
+end

data/lib/threetaps_client/core_ext.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), 'core_ext', '*.rb')].sort.each do |file|
+  require "threetaps_client/core_ext/#{File.basename(file, '*.rb')}"
+end

data/lib/threetaps_client/version.rb

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

data/lib/threetaps_client.rb

@@ -0,0 +1,82 @@
+require 'json'
+require 'restclient'
+require "threetaps_client/version"
+require "threetaps_client/core_ext"
+
+module ThreetapsClient
+  extend self
+
+  DOMAIN              = '3taps.com'
+  SEARCH_END_POINT    = "http://search.#{DOMAIN}"
+  POLLING_END_POINT   = "http://polling.#{DOMAIN}"
+  REFERENCE_END_POINT = "http://reference.#{DOMAIN}"
+
+  ANCHOR_URL          = "#{POLLING_END_POINT}/anchor"
+  POLL_URL            = "#{POLLING_END_POINT}/poll"
+
+  DATA_SOURCES_URL    = "#{REFERENCE_END_POINT}/sources"
+  CATEGORY_GROUPS_URL = "#{REFERENCE_END_POINT}/category_groups"
+  CATEGORIES_URL      = "#{REFERENCE_END_POINT}/categories"
+  LOCATIONS_URL       = "#{REFERENCE_END_POINT}/locations"
+  LOCATION_LOOKUP_URL = "#{REFERENCE_END_POINT}/locations/lookup"
+
+  attr_accessor :api_key
+
+  def search(criteria={})
+    request SEARCH_END_POINT, criteria
+  end
+
+  def anchor(timestamp=Time.now.to_i)
+    request ANCHOR_URL, :timestamp => timestamp
+  end
+
+  def poll(*args)
+    criteria = args.extract_options!
+    anchor   = args.first || criteria[:anchor]
+    anchor   = self.anchor['anchor'] if anchor.nil?
+    request POLL_URL, criteria.merge(:anchor => anchor)
+  end
+
+  def data_sources
+    request DATA_SOURCES_URL
+  end
+
+  def category_groups
+    request CATEGORY_GROUPS_URL
+  end
+
+  def categories
+    request CATEGORIES_URL
+  end
+
+  def locations(level='country')
+    request LOCATIONS_URL, :level => level
+  end
+
+  def lookup_location(code)
+    request LOCATION_LOOKUP_URL, :code => code
+  end
+
+  def retvals
+    %w[
+      id account_id source category category_group
+      location external_id external_url heading body
+      timestamp expires language price currency
+      images annotations status immortal deleted
+    ].join(',')
+  end
+
+  def default_params
+    { :auth_token => api_key, :retvals => retvals }
+  end
+
+  def request(url, params={})
+    params   = default_params.merge params.flatten
+    response = RestClient.get url, :params => params, :accept => :json
+    response.decode_json
+  end
+
+  def log=(io)
+    RestClient.log = io
+  end
+end

data/threetaps_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'threetaps_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "threetaps_client"
+  spec.version       = ThreetapsClient::VERSION
+  spec.authors       = ["Phong Nguyen"]
+  spec.email         = ["nhphong1406@gmail.com"]
+  spec.summary       = %q{Ruby Client for 3taps API}
+  spec.description   = %q{A very simple Rest Client for 3taps API.}
+  spec.homepage      = "http://github.com/phongnh/threetaps_client"
+  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.3.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "json"
+  spec.add_dependency "rest-client", "~> 1.6.7"
+  spec.add_dependency "mime-types",  "~> 1.25.1"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: threetaps_client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Phong Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-03-02 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 3
+        - 5
+        version: 1.3.5
+  type: :development
+  requirement: *id001
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id002
+  prerelease: false
+  name: rake
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id003
+  prerelease: false
+  name: pry
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id004
+  prerelease: false
+  name: json
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 6
+        - 7
+        version: 1.6.7
+  type: :runtime
+  requirement: *id005
+  prerelease: false
+  name: rest-client
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 113
+        segments: 
+        - 1
+        - 25
+        - 1
+        version: 1.25.1
+  type: :runtime
+  requirement: *id006
+  prerelease: false
+  name: mime-types
+description: A very simple Rest Client for 3taps API.
+email: 
+- nhphong1406@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/threetaps_client.rb
+- lib/threetaps_client/core_ext.rb
+- lib/threetaps_client/core_ext/array.rb
+- lib/threetaps_client/core_ext/hash.rb
+- lib/threetaps_client/core_ext/string.rb
+- lib/threetaps_client/version.rb
+- threetaps_client.gemspec
+has_rdoc: true
+homepage: http://github.com/phongnh/threetaps_client
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby Client for 3taps API
+test_files: []
+