three_taps_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32a2bb227118ec96558aa7daefab93f5980af0dc
+  data.tar.gz: 62e5b053d3cef593824ad224951f705894b6d59a
+SHA512:
+  metadata.gz: 5e826298100046ddfafbb7f7d66b388461b9cfec8d23786f04b34f420ddfa9cf60ae2f57bc426c580c5a43c1d203a97cb0c8c69bbeea074d636b839076363005
+  data.tar.gz: 8a6bf6d85c18c24cb0bd4e23bdea20114696bb61b146c19aab677c307e00e84db04c950772974690679e078f4e3851221125fdee105ac0bfd0d47c6afbdacef3

data/lib/three_taps_api.rb

@@ -0,0 +1,6 @@
+require 'httparty'
+
+# Require every file in lib/api
+Dir[File.dirname(__FILE__) + '/three_taps_api/*.rb'].each do |file|
+  require file
+end

data/lib/three_taps_api/base.rb

@@ -0,0 +1,25 @@
+require_relative 'location'
+
+module ThreeTapsAPI
+  def self.rec_hash_to_openstruct(hash)
+    raise TypeError  if not hash.is_a? Hash
+    hash = hash.map { |k, v| [k, v.is_a?(Hash) ? rec_hash_to_openstruct(v) : v] }
+    OpenStruct.new Hash[hash]
+  end
+
+  class Base
+    include HTTParty
+    base_uri '3taps.com'
+    @@api_key = ENV['THREE_TAPS_API_KEY']
+    attr_reader :results
+
+    def self.api_key
+      @@api_key
+    end
+
+    def auth_token_hash
+      { auth_token: self.class.api_key }
+    end
+
+  end
+end

data/lib/three_taps_api/location.rb

@@ -0,0 +1,13 @@
+module ThreeTapsAPI
+  # Class for describing the 3taps location in an API-specific way
+  class Location
+    # Add more attributes as they are tested
+    attr_accessor :country, :zipcode
+
+    def initialize(args)
+      args.each do |k, v|
+        self.send "#{k}=", v if self.class.method_defined? "#{k}"
+      end
+    end
+  end
+end

data/lib/three_taps_api/reference.rb

@@ -0,0 +1,34 @@
+require_relative 'base'
+
+module ThreeTapsAPI
+  class Reference < Base
+    base_uri 'reference.3taps.com'
+
+    def locations(level)
+      uri = self.class.base_uri + '/locations'
+      @results = self.class.get uri, { query: auth_token_hash.merge({ level: level }) }
+
+      begin
+        parsed_response = ThreeTapsAPI.rec_hash_to_openstruct @results.parsed_response
+        @reference = parsed_response.send "#{level.to_s}" if parsed_response.success
+      rescue TypeError
+        p "ThreeTapsAPI::Reference.locations #{level.to_s}: rec_hash_to_openstruct not passed a hash"
+      end
+    end
+
+    def method_missing(name, *args, &block) 
+      p "#{name} is not a valid parameter." and return if ThreeTapsAPI.invalid_parameter? name
+      uri = self.class.base_uri + "/#{name.to_s}"
+      @results = self.class.get uri, { query: auth_token_hash }
+
+      # if it's a valid request,
+      # create a get/setter for it
+      begin
+        parsed_response = ThreeTapsAPI.rec_hash_to_openstruct @results.parsed_response
+        @reference = parsed_response.send "#{name.to_s}" if parsed_response.success
+      rescue TypeError
+        p "ThreeTapsAPI::Reference.locations #{name.to_s}: rec_hash_to_openstruct not passed a hash"
+      end
+    end
+  end
+end

data/lib/three_taps_api/search.rb

@@ -0,0 +1,47 @@
+require_relative 'base'
+
+module ThreeTapsAPI
+  class Search < Base
+    base_uri 'search.3taps.com'
+    attr_reader :postings
+    attr_reader :parameters
+    attr_accessor :location
+
+    def create_getter_and_setter(name)
+      get = Proc.new { instance_variable_get "@#{name}" }
+      set = Proc.new { |val| instance_variable_set "@#{name}", val; @parameters[name.to_sym] = val }
+      self.class.send :define_method, "#{name}", get
+      self.class.send :define_method, "#{name}=", set
+    end
+
+    def initialize(args = {})
+      @parameters = args
+      @location = Location.new(args.delete(:location) || {})
+      @postings = OpenStruct.new
+
+      #args.delete :location
+
+      args.each do |k, v|
+        create_getter_and_setter k if ThreeTapsAPI.valid_parameter? k.to_s
+        self.send "#{k.to_s}=", v
+      end 
+    end
+
+    def search
+      opts = {}
+      opts.merge!(auth_token_hash)
+        .merge!(@parameters)
+      @results = self.class.get self.class.base_uri, { query: opts }
+      @postings = @results.parsed_response['postings'].map { |p| ThreeTapsAPI.rec_hash_to_openstruct p }
+    end
+
+    def method_missing(name, *args, &block)
+      # TODO: return if not a setter function
+      name = name.to_s.chop if name.to_s.reverse[0] == '='
+      p "#{name} is not a valid parameter." and return if ThreeTapsAPI.invalid_parameter? name
+      @parameters[name.to_sym] = args[0]
+      create_getter_and_setter name
+      self.send "#{name.to_s}=".to_sym, args[0]
+    end
+  end
+end

data/lib/three_taps_api/valid_parameters.rb

@@ -0,0 +1,20 @@
+module ThreeTapsAPI
+  @@valid_parameters = %w(category_group category_groups
+                        category categories radius 
+                        lat long source sources external_id 
+                        heading body text timestamp id 
+                        price currency annotations status 
+                        state has_image has_price include_deleted 
+                        only_deleted location locations)
+  def self.valid_parameters 
+    @@valid_parameters
+  end
+  
+  def self.valid_parameter?(str)
+    @@valid_parameters.include? str
+  end
+
+  def self.invalid_parameter?(str)
+    !self.valid_parameter? str
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: three_taps_api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Marinelli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies: []
+description: A simple, lightweight wrapper to call the 3taps API.  Requires an authentication
+  key from the 3taps service.
+email: john@johnmarinelli.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/three_taps_api.rb
+- lib/three_taps_api/base.rb
+- lib/three_taps_api/location.rb
+- lib/three_taps_api/reference.rb
+- lib/three_taps_api/search.rb
+- lib/three_taps_api/valid_parameters.rb
+homepage: http://rubygems.org/gems/three_taps_api
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Wrapper for the 3taps API.
+test_files: []