ohmage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bb1f2b405dcf481e20c0fb439eb0853da169fb4
+  data.tar.gz: f0e3544e9057623c8f89f4cc27ef4d3291b7ca7f
+SHA512:
+  metadata.gz: 00103e4c52f43a0fd5a91acd10f568cd0f30d084f0d525118eb6c2c1d09e155604f2a67aa926a555426011d48cfbda6819ae4464be80c1360a80d62be56a8d43
+  data.tar.gz: 413e3ee2df7afdf4285c30710b143b43595532ce135718f2294e58f17fb4cd25dc8c84863305eae5ee22aca9b8fc9d2eda127c4017653e934417ad20ef0f9526

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2015 Steve Nolen
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/ohmage

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'ohmage/cli'
+
+Ohmage::CLI.start(ARGV)

data/lib/ohmage/api.rb

@@ -0,0 +1,11 @@
+require 'ohmage/user'
+require 'ohmage/campaign'
+require 'ohmage/clazz'
+
+module Ohmage
+  module API
+    include Ohmage::API::User
+    include Ohmage::API::Clazz
+    include Ohmage::API::Campaign
+  end
+end

data/lib/ohmage/campaign.rb

@@ -0,0 +1,19 @@
+module Ohmage
+  module API
+    module Campaign
+      #
+      # ohmage campaign/read call
+      # @see https://github.com/ohmage/server/wiki/Campaign-Manipulation#campaignRead
+      # @returns [Array: Ohmage::Campaign objects] matching criteria and output format
+      def campaign_read(params = {})
+        request = Ohmage::Request.new(self, :post, 'campaign/read', params)
+        # TODO: make a utility to abstract creation of array of base objects
+        t = []
+        request.perform[:data].each do |k, v|
+          t << Ohmage::Campaign.new(k => v)
+        end
+        t
+      end
+    end
+  end
+end

data/lib/ohmage/clazz.rb

@@ -0,0 +1,31 @@
+module Ohmage
+  module API
+    module Clazz
+      #
+      # ohmage class/read call
+      # @see https://github.com/ohmage/server/wiki/Class-Manipulation#classRead
+      # @returns [Array: Ohmage::Class objects] matching criteria
+      #
+      def class_read(params = {})
+        request = Ohmage::Request.new(self, :post, 'class/read', params)
+        # TODO: make a utility to abstract creation of array of base objects
+        t = []
+        request.perform[:data].each do |k, v|
+          t << Ohmage::Clazz.new(k => v)
+        end
+        t
+      end
+
+      def class_create(params = {})
+        request = Ohmage::Request.new(self, :post, 'class/create', params)
+        request.perform
+        class_read(class_urn_list: params[:class_urn])
+      end
+
+      def class_delete(params = {})
+        request = Ohmage::Request.new(self, :post, 'class/delete', params)
+        request.perform
+      end
+    end
+  end
+end

data/lib/ohmage/cli.rb

@@ -0,0 +1,114 @@
+require 'thor'
+require 'ohmage'
+require 'ohmage/cli_helpers'
+
+module Ohmage
+  class CLI < Thor
+    include Ohmage::CliHelpers
+
+    class List < Thor
+      class_option :table, aliases: :t, type: :boolean, desc: 'formats output as table'
+
+      desc 'ls campaign <options>', 'Lists campaigns current user has access to'
+      option :search, aliases: :s, desc: 'a search string to limit the returned campaign list'
+      def campaign
+        ls = Ohmage.campaign_read(campaign_name_search: options[:search], output_format: 'short')
+        Ohmage::CLI_Helpers.format_output(ls, options[:table], [:name, :urn, :description], :urn)
+      end
+
+      desc 'ls class <options>', 'Lists classes current user has access to'
+      def clazz(urn_list = nil)
+        ls = Ohmage.class_read(class_urn_list: urn_list)
+        Ohmage::CLI_Helpers.format_output(ls, options[:table], [:name, :urn, :description, :role, :users], :urn)
+      end
+
+      desc 'ls user <options>', 'Lists users that match criteria of search, all viewable if no search'
+      option :search, aliases: :s, desc: 'a search string to limit the returned user list'
+      def user(username = nil)
+        ls = Ohmage.user_read(user_list: username, username_search: options[:search])
+        Ohmage::CLI_Helpers.format_output(ls, options[:table], [:username, :email_address, :enabled, :admin, :new_account], :username)
+      end
+    end
+
+    class Create < Thor
+      class_option :table, aliases: :t, type: :boolean, desc: 'formats output as table'
+
+      desc 'create user <username> <options>', 'creates a new ohmage user with parameters'
+      option :password, required: true, aliases: :p, desc: 'value for new user password'
+      option :admin, type: :boolean, default: false, desc: 'is user admin?'
+      option :enabled, type: :boolean, default: true, desc: 'is user enabled?'
+      option :new, type: :boolean, aliases: :first_login, default: true, desc: 'force password reset on first login?'
+      def user(username)
+        new_user = Ohmage.user_create(username: username,
+                                      password: options[:password],
+                                      admin: options[:admin],
+                                      enabled: options[:enabled],
+                                      new_account: options[:new])
+        Ohmage::CLI_Helpers.format_output(new_user, options[:table], [:username], :username)
+      end
+
+      desc 'create class <class_urn> <class_name> <options>', 'creates a new ohmage class with parameters'
+      option :description, aliases: :d, type: :string, desc: 'description of class'
+      def clazz(urn, name)
+        new_class = Ohmage.class_create(class_urn: urn,
+                                        class_name: name,
+                                        description: options[:description])
+        Ohmage::CLI_Helpers.format_output(new_class, options[:table], [:urn, :name, :description], :urn)
+      end
+    end
+
+    class Delete < Thor
+      desc 'delete clazz <class_urn>', 'deletes an existing ohmage class'
+      def clazz(urn)
+        Ohmage.class_delete(class_urn: urn)
+      end
+    end
+
+    class Update < Thor
+      class_option :table, aliases: :t, type: :boolean, default: true, desc: 'formats output as table'
+
+      desc 'update user <username> <options>', 'updates provided values for a given username'
+      option :admin, type: :boolean, desc: 'is user admin?'
+      option :new, type: :boolean, desc: 'force pw reset on login?'
+      def user(username)
+        updated_user = Ohmage.user_update(username: username,
+                                          admin: options[:admin],
+                                          enabled: options[:enabled],
+                                          new_account: options[:new])
+        Ohmage::CLI_Helpers.format_output(updated_user, options[:table], [:username, :admin, :enabled, :new_account], :username)
+      end
+
+      desc 'update password <username> <options>', "updates provided user's password"
+      option :password, required: true, aliases: :p, desc: 'new password for user'
+      def password(username)
+        Ohmage.user_password(username: username, new_password: options[:password])
+      end
+    end
+
+    desc 'hi', 'returns current config'
+    def hi
+      conf = Ohmage.client
+      puts 'Server: ' + conf.host
+      puts 'Current User: ' + conf.user
+      conf.server_config.each do |k, v|
+        puts k.to_s + ': ' + v.to_s
+      end
+    end
+
+    # Allow use of either ls or list. I don't see any reference to aliasing subcommands
+    # so i'll just do this for now!
+    %w(ls list).each do |l|
+      desc "#{l} <entity>", 'lists specified entity current user has access to'
+      subcommand l, List
+    end
+
+    desc 'create <entity>', 'creates an entity matching the required info.'
+    subcommand 'create', Create
+
+    desc 'delete <entity>', 'deletes an entity matching required info'
+    subcommand 'delete', Delete
+
+    desc 'update <entity>', 'updates an entity matching info'
+    subcommand 'update', Update
+  end
+end

data/lib/ohmage/cli_helpers.rb

@@ -0,0 +1,24 @@
+require 'formatador'
+
+module Ohmage
+  module CliHelpers
+    def self.format_output(d, table, fields, no_table_field) # rubocop:disable MethodLength
+      # accepts an ohmage entity array and returns output (table or newline given table boolean)
+      output = []
+      d.each do |i|
+        @line = {}
+        fields.each do |f|
+          @line.merge!(f.to_sym => i.send(f).to_s)
+        end
+        output << @line
+      end
+      if table
+        Formatador.display_compact_table(output, fields)
+      else
+        output.each do |v|
+          Formatador.display_line(v[no_table_field])
+        end
+      end
+    end
+  end
+end

data/lib/ohmage/client.rb

@@ -0,0 +1,46 @@
+require 'ohmage/api'
+require 'ohmage/request'
+
+module Ohmage
+  class Client
+    include Ohmage::API
+    attr_accessor :host, :port, :path, :client_string, :user, :password, :token, :server_config
+    def initialize(options = {}) # rubocop:disable MethodLength
+      self.server_url = ENV['OHMAGE_SERVER_URL']
+      self.user = ENV['OHMAGE_USER']
+      self.password = ENV['OHMAGE_PASSWORD']
+      self.client_string = 'ruby-ohmage'
+      self.path = 'app/'
+      self.port = 443
+      options.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+      yield(self) if block_given?
+      server_config_read
+      self
+    end
+    #
+    # ohmage config/read call
+    # @returns [Hash] of server config details
+    def server_config_read
+      request = Ohmage::Request.new(self, :get, 'config/read', {})
+      resp = request.perform
+      self.server_config = resp[:data]
+    end
+    #
+    # ohmage user/auth_token call
+    # @see https://github.com/ohmage/server/wiki/User-Authentication#statefulAuthentication
+    # @returns String: auth_token valid for server's auth_token_lifetime param
+    #
+    def auth_token
+      params = {}
+      params['user'] = user
+      params['password'] = password
+      request = Ohmage::Request.new(self, :post, 'user/auth_token', params)
+      resp = request.perform
+      self.token = resp[:token]
+      resp[:token]
+    end
+    alias_method :auth, :auth_token
+  end
+end

data/lib/ohmage/entity/campaign.rb

@@ -0,0 +1,19 @@
+module Ohmage
+  class Campaign
+    # @return [String]
+    attr_reader :urn, :name, :icon_url, :authored_by, :running_state, :privacy_state, :creation_timestamp, :description, :xml
+    alias_method :author, :authored_by
+    # @return [Array]
+    attr_reader :user_roles, :classes
+    alias_method :roles, :user_roles
+    # @return [Hash]
+    attr_reader :user_role_campaign
+
+    def initialize(attrs = {})
+      @urn = attrs.keys[0].to_s
+      attrs.values[0].each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/ohmage/entity/clazz.rb

@@ -0,0 +1,16 @@
+module Ohmage
+  class Clazz
+    # @return [String]
+    attr_reader :urn, :name, :description, :role
+    attr_reader :my_role, :role
+    # @return [Hash]
+    attr_reader :users
+
+    def initialize(attrs = {})
+      @urn = attrs.keys[0].to_s
+      attrs.values[0].each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/ohmage/entity/user.rb

@@ -0,0 +1,22 @@
+module Ohmage
+  class User
+    # #return [String]
+    attr_reader :username, :first_name, :last_name, :organization, :personal_id, :email_address
+    alias_method :id, :username
+    alias_method :user, :username
+    alias_method :org, :organization
+    alias_method :email, :email_address
+    # @return [Object]
+    attr_reader :permissions, :classes, :campaigns
+    # @return [TrueClass, FalseClass]
+    attr_reader :enabled, :can_setup_users, :new_account, :can_create_classes, :can_create_campaigns, :admin, :is_admin
+
+    def initialize(attrs = {})
+      @username = attrs.keys[0].to_s
+      attrs.values[0].each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+      @permissions.each { |k, v| instance_variable_set("@#{k}", v) }
+    end
+  end
+end

data/lib/ohmage/error.rb

@@ -0,0 +1,111 @@
+module Ohmage
+  class Error < StandardError
+    ClientError = Class.new(self)
+    BadRequest = Class.new(ClientError)
+    Unauthorized = Class.new(ClientError)
+    NotFound = Class.new(ClientError)
+    NotAcceptable = Class.new(ClientError)
+    InvalidToken = Class.new(ClientError)
+    InvalidParameter = Class.new(ClientError)
+    MobilityException = Class.new(ClientError)
+    SurveyException = Class.new(ClientError)
+    CampaignException = Class.new(ClientError)
+    ImageException = Class.new(ClientError)
+    ClassException = Class.new(ClientError)
+    UserException = Class.new(ClientError)
+    CatchAll = Class.new(ClientError)
+
+    ServerError = Class.new(self)
+    InternalServerError = Class.new(ServerError)
+    BadGateway = Class.new(ServerError)
+    ServiceUnavailable = Class.new(ServerError)
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS = {
+      888 => Ohmage::Error::CatchAll, # just, i don't know, catch 'em all.
+      400 => Ohmage::Error::BadRequest,
+      401 => Ohmage::Error::Unauthorized,
+      404 => Ohmage::Error::NotFound,
+      405 => Ohmage::Error::Unauthorized,
+      406 => Ohmage::Error::NotAcceptable,
+      500 => Ohmage::Error::InternalServerError,
+      502 => Ohmage::Error::BadGateway,
+      503 => Ohmage::Error::ServiceUnavailable,
+      504 => Ohmage::Error::GatewayTimeout,
+    }
+    # How ugly is this??
+    STRING_ERRORS = {
+      '0100' => Ohmage::Error::InternalServerError,
+      '0101' => Ohmage::Error::InternalServerError,
+      # Auth
+      '0200' => Ohmage::Error::Unauthorized,
+      '0201' => Ohmage::Error::Unauthorized,
+      '0202' => Ohmage::Error::Unauthorized,
+      '0203' => Ohmage::Error::InvalidToken,
+    }
+    ('0300'..'0312').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::InvalidParameter
+    end
+    ('0500'..'0503').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::MobilityException
+    end
+    ('0600'..'0630').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::SurveyException
+    end
+    ('0700'..'0713').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::CampaignException
+    end
+    ('0800'..'0803').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::ImageException
+    end
+    ('0900'..'0906').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::ClassException
+    end
+    ('1000'..'1017').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::UserException
+    end
+    ('1100'..'1803').to_a.each do |e|
+      STRING_ERRORS[e] = Ohmage::Error::CatchAll
+    end
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @param body [String]
+      # @return [Ohmage::Error]
+      def from_response(body)
+        message, code = parse_error(body)
+        # ohmage returns own error codes in body and as strings.
+        if code.is_a? String
+          new(message, 888)
+        else
+          new(message, code)
+        end
+      end
+
+    private
+
+      def parse_error(body)
+        if body.nil? || body.empty?
+          ['', nil]
+        elsif body[:errors]
+          extract_message_from_errors(body)
+        end
+      end
+
+      def extract_message_from_errors(body)
+        first = Array(body[:errors]).first
+        [first[:text], first[:code]]
+      end
+    end
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param rate_limit [Hash]
+    # @param code [Integer]
+    # @return [Ohmage::Error]
+    def initialize(message = '', code = nil)
+      super(message)
+      @code = code
+    end
+  end
+end

data/lib/ohmage/request.rb

@@ -0,0 +1,81 @@
+module Ohmage
+  class Request
+    def initialize(client, request_method, api, options = {}) # rubocop:disable MethodLength
+      @client = client
+      @uri = Addressable::URI.parse(@client.server_url + @client.path + api)
+      @options = options
+      @options['client'] = @client.client_string
+      case api
+      when 'config/read', 'user/auth_token', 'user/auth'
+        # these calls don't need auth
+      else
+        @client.auth if @client.token.nil?
+        @options['auth_token'] = @client.token
+      end
+
+      @request_method = request_method
+    end
+    def perform # rubocop:disable all
+      response = HTTP.public_send(@request_method, @uri.to_s, params: @options)
+      response_body = symbolize_keys!(response.parse)
+      response_headers = response.headers
+      begin
+        fail_or_return_response_body(response.status, response_body, response_headers)
+      rescue Ohmage::Error::InvalidToken
+        @client.auth
+        # refactor this, essentially recursively performs the request if it token failed
+        # on the first try. bad, bad, bad.
+        @options['auth_token'] = @client.token
+        response = HTTP.public_send(@request_method, @uri.to_s, params: @options)
+        response_body = symbolize_keys!(response.parse)
+        response_headers = response.headers
+        fail_or_return_response_body(response.status, response_body, response_headers)
+      end
+    end
+
+    def symbolize_keys!(object)
+      if object.is_a?(Array)
+        object.each_with_index do |val, index|
+          object[index] = symbolize_keys!(val)
+        end
+      elsif object.is_a?(Hash)
+        object.keys.each do |key|
+          object[key.to_sym] = symbolize_keys!(object.delete(key))
+        end
+      end
+      object
+    end
+
+    def fail_or_return_response_body(code, body, headers)
+      error = error(code, body, headers)
+      fail(error) if error
+      body
+    end
+
+    def error(code, body, _headers) # rubocop:disable all
+      # ohmage doesn't really return HTTP error codes
+      # so we're going to catch the real ones first, assuming
+      # they are sent from the web server (like 502 or 404)
+      klass = Ohmage::Error::ERRORS[code]
+      if klass.nil?
+        # we're not necessarily sure that this really isn't an error
+        # so we have to inspect the response body to look for result:failure
+        if body[:result] == 'failure'
+          # then ohmage also considers this a failure. weird, but let's try a new way to handle this
+          # we also want to smartly handle auth token errors, since we ohmage does not currently have
+          # persistent tokens
+          @code = body[:errors].first[:code]
+          @message = body[:errors].first[:text]
+          if @message =~ /token/ # rubocop:disable Metrics/BlockNesting
+            @code = '0203' # a new fake error code for catching token errors
+          end
+          klass = Ohmage::Error::STRING_ERRORS[@code]
+          klass.from_response(body) # refactor this.
+        end # body has { "result": "success" }, so let's assume it isn't a failure.
+      else
+        # return the base error
+        klass.from_response(body)
+      end
+    end
+  end
+end

data/lib/ohmage/user.rb

@@ -0,0 +1,59 @@
+module Ohmage
+  module API
+    module User
+      #
+      # ohmage user/read call
+      # @see https://github.com/ohmage/server/wiki/User-Manipulation#userRead
+      # @returns [Array: Ohmage::User objects] that match param criteria
+      #
+      def user_read(params = {})
+        request = Ohmage::Request.new(self, :post, 'user/read', params)
+        t = []
+        request.perform[:data].each do |k, v|
+          t << Ohmage::User.new(k => v)
+        end
+        t
+      end
+
+      #
+      # ohmage user_info/read call
+      # @see https://github.com/ohmage/server/wiki/User-Manipulation#userInfoRead
+      # @returns Object: detailed list of classes/campaign current user can access
+      #
+      def user_info_read
+        request = Ohmage::Request.new(self, :post, 'user_info/read', {})
+        Ohmage::User.new(request.perform[:data])
+      end
+
+      #
+      # ohmage user/create call
+      # @see https://github.com/ohmage/server/wiki/User-Manipulation#userCreate
+      # @returns [Object: Ohmage::User]
+      #
+      def user_create(params = {})
+        request = Ohmage::Request.new(self, :post, 'user/create', params)
+        request.perform
+        user_read(user_list: params[:username])
+      end
+
+      #
+      # ohmage user/update call
+      # @see https://github.com/ohmage/server/wiki/User-Manipulation#userUpdate
+      # @returns [Object: Ohmage::User]
+      #
+      def user_update(params = {})
+        request = Ohmage::Request.new(self, :post, 'user/update', params)
+        request.perform
+        user_read(user_list: params[:username])
+      end
+
+      def user_password(params = {}) # is this method name odd?
+        # this api call demands current user's info.
+        params[:user] = user
+        params[:password] = password
+        request = Ohmage::Request.new(self, :post, 'user/change_password', params)
+        request.perform
+      end
+    end
+  end
+end

data/lib/ohmage/version.rb

@@ -0,0 +1,45 @@
+module Ohmage
+  module Version
+  module_function
+
+    # @return [Integer]
+    def major
+      0
+    end
+
+    # @return [Integer]
+    def minor
+      0
+    end
+
+    # @return [Integer]
+    def patch
+      1
+    end
+
+    # @return [Integer, NilClass]
+    def pre
+      nil
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        major: major,
+        minor: minor,
+        patch: patch,
+        pre: pre,
+      }
+    end
+
+    # @return [Array]
+    def to_a
+      to_h.values.compact
+    end
+
+    # @return [String]
+    def to_s
+      to_a.join('.')
+    end
+  end
+end

data/lib/ohmage.rb

@@ -0,0 +1,28 @@
+require 'http'
+require 'addressable/uri'
+require 'ohmage/error'
+require 'ohmage/client'
+require 'ohmage/user'
+require 'ohmage/request'
+require 'ohmage/entity/user'
+require 'ohmage/entity/clazz'
+require 'ohmage/entity/campaign'
+require 'ohmage/version'
+
+module Ohmage
+  # @return [Ohmage::Client]
+  def self.client(options = {})
+    Ohmage::Client.new(options)
+  end
+
+  # Delegate to Ohmage::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Ohmage::Client
+  def self.respond_to?(method)
+    client.respond_to?(method) || super
+  end
+end

data/ohmage.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ohmage/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'addressable'
+  spec.add_dependency 'http', '~> 0.7.3'
+  spec.add_dependency 'thor', '~> 0.19.1'
+  spec.add_dependency 'formatador', '~> 0.2.5'
+  spec.authors = ['Steve Nolen']
+  spec.description = 'A Ruby interface for the ohmage 2.x API.'
+  spec.email = %w(technolengy@gmail.com)
+  spec.files = %w(LICENSE.txt ohmage.gemspec bin/ohmage) + Dir['lib/**/*.rb']
+  spec.homepage = 'https://github.com/ohmage/gem'
+  spec.licenses = %w(Apache 2)
+  spec.name = 'ohmage'
+  spec.executables = 'ohmage'
+  spec.require_paths = %w(lib)
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_rubygems_version = '>= 1.3.5'
+  spec.summary = spec.description
+  spec.version = Ohmage::Version
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ohmage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steve Nolen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+description: A Ruby interface for the ohmage 2.x API.
+email:
+- technolengy@gmail.com
+executables:
+- ohmage
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- bin/ohmage
+- lib/ohmage.rb
+- lib/ohmage/api.rb
+- lib/ohmage/campaign.rb
+- lib/ohmage/clazz.rb
+- lib/ohmage/cli.rb
+- lib/ohmage/cli_helpers.rb
+- lib/ohmage/client.rb
+- lib/ohmage/entity/campaign.rb
+- lib/ohmage/entity/clazz.rb
+- lib/ohmage/entity/user.rb
+- lib/ohmage/error.rb
+- lib/ohmage/request.rb
+- lib/ohmage/user.rb
+- lib/ohmage/version.rb
+- ohmage.gemspec
+homepage: https://github.com/ohmage/gem
+licenses:
+- Apache
+- '2'
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A Ruby interface for the ohmage 2.x API.
+test_files: []
+has_rdoc: