casual_helper 0.0.1

data/lib/casual_helper.rb

@@ -0,0 +1,165 @@
+require 'rest-client'
+require 'json'
+require "casual_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
+* log errors and return nil
+
+todo
+* improve error handling
+* handle each exception type differently
+
+=end
+
+JSON_CONTENT = {:content_type => :json, :accept => :json}
+
+module CasualHelper
+  class Api
+
+    def initialize(api_server)
+      @api_server = api_server
+    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
+
+    def get_drop(tap_id, drop_id)
+      return if are_invalid tap_id, drop_id
+      get "#{@api_server.to_s}/v0/taps/#{tap_id}/drops/#{drop_id}"
+    end
+
+    def add_tap(options)
+      return if are_invalid tap_id
+      post "#{@api_server.to_s}/v0/taps", options
+    end
+
+    def get_tap(tap_id)
+      return if are_invalid tap_id
+      get "#{@api_server.to_s}/v0/taps/#{tap_id}"
+    end
+
+    def get_taps
+      get "#{@api_server.to_s}/v0/taps"
+    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
+
+    # authenticates the user with the API and returns their Casual 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, JSON_CONTENT
+      response = JSON.parse(response_json)
+      response['response']
+    rescue => e
+      log_error url, e
+    end
+
+    def get_user(id)
+      return if are_invalid 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.to_json
+    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
+
+    private
+
+    def get(url)
+      response = RestClient.get url
+      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, JSON_CONTEN
+      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, JSON_CONTENT
+      response = JSON.parse(response_json)
+      response['meta']['code'] >= 200 && response['meta']['code'] <= 300
+    rescue => e
+      log_error url, e
+    end
+
+    def are_invalid(*params)
+      if params.nil? || params.any? {|param| param.nil? }
+        p "Error in #{calling_method} - one or more parameters is nil - #{params.to_json}"
+        true
+      else
+        false
+      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}"
+      p "  url: #{url}"
+      p "  message: #{message}"
+      nil
+    end
+
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: casual_helper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- matthewspivey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-20 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Casual gem
+email: 
+- spivey.mathew@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/casual_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A casual gem, that probably isn't what you're looking for
+test_files: []
+