aux_helper 0.0.20

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3ee692e128de8b1e9507e910144127bf78d1356
+  data.tar.gz: df1f2c16e500b9b45492b7e913db93a1e2ed5b73
+SHA512:
+  metadata.gz: 00a4283309084403afb0950eaf0c5035588aa45ee00f89949f79aa59d652fa75e45c839201b98603cc5973197aade5a1de01d59addf70ec4b2bd704b8d963b3a
+  data.tar.gz: 182967f328c80f0faeb1f33f0137b3a3a797b2190f2fead48321d6f6e7421d9f8f2a0fbbb88e9eeed59a945a708c6764f473bb385b4bb47f0b31cd388195f877

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/aux_helper.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/aux_helper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["thor-aux"]
+  gem.email         = ["gems@thorshammer.us	"]
+  gem.description   = %q{aUX gem}
+  gem.summary       = %q{aUX API helper}
+  gem.homepage      = ""
+
+  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.name          = "aux_helper"
+  gem.require_paths = ["lib"]
+  gem.version       = AUXHelper::VERSION
+
+  gem.add_runtime_dependency "rest-client"
+  gem.add_runtime_dependency "json"
+end

data/lib/aux_helper/version.rb

@@ -0,0 +1,3 @@
+module AUXHelper
+  VERSION = "0.0.20"
+end

data/lib/aux_helper.rb

@@ -0,0 +1,288 @@
+require 'rest-client'
+require 'json'
+require "aux_helper/version"
+
+=begin
+
+assumptions
+* helper users require that error information be logged, not returned
+* helper users won't ever deal with API URIs
+* the SDK should implement ActiveRecord classes
+* model classes should define variables and set them to default values
+
+design decisions
+* on error: log error message and return nil
+
+todo
+* improve error handling
+* handle each exception type differently
+
+=end
+
+module AUXHelper
+  ##
+  # AUXHelper::Api makes it easier to use the Alpha UX backend REST API
+  #
+  # == Usage
+  #
+  #   api = AUXHelper::Api.new 'http://localhost:9393'
+  #
+  class Api
+
+    def initialize(api_server, api_key=nil)
+      @api_server = api_server
+      @api_key = api_key      
+      p " Running AUXHelper version #{AUXHelper::VERSION}"
+    end
+
+    attr_reader :api_server
+
+    # return true when all environment variables are set
+    def self.validate_env_variables(env_vars)
+      p "Enivonrment variables at runtime"
+      env_vars.all? {|env_var|
+        if ENV.has_key? env_var
+          p "  #{env_var}=#{ENV[env_var]}"
+          true
+        else
+          p "  #{env_var} is not set! The application will not start."
+          false
+        end
+      }
+    end
+
+    #
+    # == Description
+    #
+    # Fetch all recent taps from the Alpha UX API server
+    #
+    # Example:
+    #
+    #     drops = api.get_taps #=> [{"id" => "0123456789abcdef01234567", ...}, ...]
+    #
+    # Returns nil on error.
+    #
+    # TODO - add limit parameter
+    #
+    def get_taps
+      get "#{@api_server.to_s}/v0/taps"
+    end
+
+    #
+    # == Description
+    #
+    # Fetch the tap with the specified ID
+    #
+    # @param tap_id If valid mongo ID string for an existing tap, the tap
+    # will be returned as a hash
+    #
+    # Example:
+    #
+    #     tap = api.get_tap('0123456789abcdef01234567') #=> {"id" => "0123456789abcdef01234567", ...}
+    #
+    # Returns nil on error.
+    #
+    def get_tap(tap_id)
+      #return if are_invalid_mongo_key tap_id
+      get "#{@api_server.to_s}/v0/taps/#{tap_id}"
+    end
+    
+    def update_tap(tap_id, options)
+      return if are_invalid options
+      put "#{@api_server.to_s}/v0/taps/#{tap_id}", options
+    end
+    
+    #
+    # == Description
+    #
+    # Fetch the drop with the specified IDs
+    #
+    # @param tap_id string containing the mongo ID of an existing tap
+    # @param drop_id string containing the mongo ID of an existing drop
+    #
+    # Example:
+    #
+    #     tap = api.get_tap('0123456789abcdef01234567', 5) #=> {"id" => 5, "tap_id" => "7654321fedcba9876543210", ...}
+    #
+    # Returns nil on error.
+    #
+    def get_drop(tap_id, drop_id)
+      #return if are_invalid_mongo_key tap_id
+      return if are_invalid drop_id
+      get "#{@api_server.to_s}/v0/taps/#{tap_id}/drops/#{drop_id.to_i}"
+    end
+
+    def add_tap(options)
+      return if are_invalid options
+      post "#{@api_server.to_s}/v0/taps", options
+    end
+
+    def add_drop(tap_id, options)
+      return if are_invalid tap_id, options
+      post "#{@api_server.to_s}/v0/taps/#{tap_id.to_s}/drops", options
+    end
+    
+    def update_drop(tap_id, drop_id, options)
+      return if are_invalid tap_id, options
+      put "#{@api_server.to_s}/v0/taps/#{tap_id.to_s}/drops/#{drop_id.to_s}", options
+    end
+
+    # authenticates the user with the API and returns their profile
+    def auth_user(auth)
+      return if are_invalid auth
+      # note - differences from 'post': (1) no .to_json (2) return response hash
+      response_json = RestClient.post "#{@api_server.to_s}/v0/users/authenticate", auth, compute_headers(true)
+      response = JSON.parse(response_json)
+      response['response']
+    rescue => e
+      log_error auth, e
+    end
+
+    def get_user(id)
+      #return if are_invalid_mongo_key id
+      get "#{@api_server.to_s}/v0/users/#{id}"
+    end
+
+    # add email address to signup list
+    # returns true if successful
+    def signup_email(email_address)
+      return if are_invalid email
+      post "#{@api_server.to_s}/v0/register", { :address => email_address.to_s }
+    end
+
+    def update_drop_feedback(tap_id, drop_id, update)
+      return if are_invalid tap_id, drop_id, update
+      post "#{@api_server.to_s}/v0/taps/#{tap_id}/drops/#{drop_id}/update", update
+    end
+
+    def lookup_alias(element_alias)
+      return if are_invalid element_alias
+      get "#{@api_server.to_s}/v0/aliases/#{element_alias}"
+    end
+
+    def update_location(drop_uri, longitude, latitude)
+      return if are_invalid drop_uri, longitude, latitude
+      put drop_uri, { :location => [longitude, latitude] }
+    end
+
+    def update_user(user_id, body)
+      return if are_invalid user_id, body
+      put "#{@api_server.to_s}/v0/users/#{user_id}", body
+    end
+
+    def add_comment_tap(tap_id, comment_string)
+      return if are_invalid tap_id, comment_string
+      post "#{@api_server.to_s}/v0/taps/#{tap_id}/update", { :feedback => { :comments => [comment_string] } }
+    end
+    
+    #COUNTERS
+    
+    def update_counters_tap(tap_id, counter_id, amount)
+      return if are_invalid tap_id, counter_id, amount
+      counters_hash = Hash.new
+      counters_hash[counter_id] = amount
+      post "#{@api_server.to_s}/v0/taps/#{tap_id}/update", { :feedback => { :counters => counters_hash } }
+    end
+    
+    #TAGS
+    def set_tags_tap(tap_id, tags)
+      return if are_invalid tap_id, tags
+      post "#{@api_server.to_s}/v0/taps/#{tap_id}/update", {:feedback => { :set_tags => tags}}      
+    end
+    
+    def unset_tags_tap(tap_id, tags)
+      return if are_invalid tap_id, tags
+      post "#{@api_server.to_s}/v0/taps/#{tap_id}/update", {:feedback => { :unset_tags => tags}}      
+    end
+
+    # @return hash with attributes passed in and readable_id
+    def get_config(id)
+      return if are_invalid id
+      get "#{@api_server.to_s}/v0/configs/#{id}"
+    end
+
+    # @param config is a hash
+    def put_config(id, config)
+      return if are_invalid id, config
+      put "#{@api_server.to_s}/v0/configs/#{id}", config
+    end
+
+    private
+    
+    def compute_headers(isJson=false)
+      headers = Hash.new
+      if @api_key != nil
+        headers[:headers] = {"Casual-API-Key" => @api_key}
+        headers[:headers] = {"AUX-API-Key" => @api_key}
+      end
+      if isJson
+        headers[:content_type] = :json
+        headers[:accept] = :json
+      end      
+      return headers
+    end
+
+    def get(url)
+      response = RestClient.get url, compute_headers
+      parsed_response = JSON.parse(response)
+      parsed_response['response']
+    rescue => e
+      log_error url, e
+    end
+
+    def put(url, body)
+      response_json = RestClient.put url, body.to_json, compute_headers(true)
+      response = JSON.parse(response_json)
+      response['meta']['code'] >= 200 && response['meta']['code'] <= 300
+    rescue => e
+      log_error url, e
+    end
+
+    def post(url, body)
+      response_json = RestClient.post url, body.to_json, compute_headers(true)
+      response = JSON.parse(response_json)
+      response['response']
+    rescue => e
+      log_error url, e
+    end
+
+    def are_invalid(*params)
+      if params.nil? || params.any? {|param| param.nil? }
+        calling_method = caller[1][/`.*'/][1..-2]
+        p "Error in #{calling_method} - one or more parameters is nil - #{params.to_json}"
+        true
+      else
+        false
+      end
+    end
+    
+    def create_alias
+      base64_charaters = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+      (0..5).map{base64_charaters.shuffle[0]}.join
+    end
+
+    # TODO broken
+=begin
+    def are_invalid_mongo_key(*params)
+      if params.nil? || params.any? {|param| param.nil? || !param.is_a?(String) || param.count != 24}
+        calling_method = caller[1][/`.*'/][1..-2]
+        p "Error in #{calling_method} - one or more parameters is nil - #{params.to_json}"
+        true
+      else
+        false
+      end
+    end
+=end
+
+    # logs error with method name of caller
+    # always returns nil
+    def log_error(url, message)
+      calling_method = caller[1][/`.*'/][1..-2]
+      p "Error in #{self.class.name}.#{calling_method}\n" <<
+            "  url: #{url}\n" <<
+            "  message: #{message}"
+      nil
+    end
+
+  end
+end

data/readme.md

@@ -0,0 +1,5 @@
+
+'''
+gem build aux_helper.gemspec 
+gem push aux_helper-0.0.4.gem 
+'''

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: aux_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.20
+platform: ruby
+authors:
+- thor-aux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: aUX gem
+email:
+- "gems@thorshammer.us\t"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- aux_helper.gemspec
+- lib/aux_helper.rb
+- lib/aux_helper/version.rb
+- readme.md
+homepage: ''
+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.4.6
+signing_key: 
+specification_version: 4
+summary: aUX API helper
+test_files: []