ohmage 0.0.29 → 0.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fb497c26c555cb4c32f7228fc0720bfa867d116
-  data.tar.gz: 9b7a484afa92be7e62c15bb991cfe17c767b104f
+  metadata.gz: f5f9677fb88f190228aef217b6059f9428b72e26
+  data.tar.gz: eca7f33f07ed44bf775dc2bb6b84d8960f8770bf
 SHA512:
-  metadata.gz: 215bfc952f9d7fdfda7a49b12767d2344e4ac2f30eac70f27f1d079cd111074306cbd669d55914b89b407829a47b16f4756fa22b507d91d245dcce11dce85947
-  data.tar.gz: ad3b8db1d56c15e80dea8af77760922c3cc41123c3269aaa0b0eb35a71ae36c0d6e467cac41be88d45e5e814ed104798beba44e9d58c4e89500db8fa876e3a30
+  metadata.gz: 960caa295abb04ad70485681472a2f4be3c58a5f7b30eb321b5ec8f042c2deea873f7be1716d2497cda42f60f4fe75468c73e7386b0b69fb9098e14699e321ac
+  data.tar.gz: 3fc728c45d14a81f0e62f380180dc862493608df02b27748de659074ea3ab52b5794a7d5b5271f84857ca3d622f250143634d3f9621eb48b8f002c0a83cce29a

data/lib/ohmage.rb

@@ -10,6 +10,7 @@ require 'ohmage/entity/campaign'
 require 'ohmage/entity/document'
 require 'ohmage/entity/survey'
 require 'ohmage/entity/audit'
+require 'ohmage/entity/annotation'
 require 'ohmage/version'
 
 module Ohmage

data/lib/ohmage/annotation.rb

@@ -0,0 +1,65 @@
+module Ohmage
+  module API
+    module Annotation
+      #
+      # ohmage annotation/survey_response/create call
+      # @see https://github.com/ohmage/server/wiki/
+      # @returns [Array: Ohmage::Annotation objects] matching criteria and output format
+      #
+      def annotation_survey_response_create(params = {})
+        request = Ohmage::Request.new(self, :post, 'annotation/survey_response/create', params)
+        request.perform
+      end
+
+      #
+      # ohmage annotation/prompt_response/create call
+      # @see https://github.com/ohmage/server/wiki/
+      # @returns [Array: Ohmage::Annotation objects] matching criteria and output format
+      #
+      def annotation_prompt_response_create(params = {})
+        request = Ohmage::Request.new(self, :post, 'annotation/prompt_response/create', params)
+        request.perform
+      end
+
+      #
+      # ohmage annotation/survey_response/read call
+      # @see https://github.com/ohmage/server/wiki/
+      # @returns [Array: Ohmage::Annotation objects] matching criteria and output format
+      #
+      def annotation_survey_response_read(params = {})
+        request = Ohmage::Request.new(self, :post, 'annotation/survey_response/read', params)
+        # TODO: make a utility to abstract creation of array of base objects
+        t = []
+        request.perform[:data].each do |k, v|
+          t << Ohmage::Annotation.new(k => v)
+        end
+        t
+      end
+
+      #
+      # ohmage annotation/prompt_response/read call
+      # @see https://github.com/ohmage/server/wiki/
+      # @returns [Array: Ohmage::Annotation objects] matching criteria and output format
+      #
+      def annotation_prompt_response_read(params = {})
+        request = Ohmage::Request.new(self, :post, 'annotation/prompt_response/read', params)
+        # TODO: make a utility to abstract creation of array of base objects
+        t = []
+        request.perform[:data].each do |k, v|
+          t << Ohmage::Annotation.new(k => v)
+        end
+        t
+      end
+
+      #
+      # ohmage annotation/delete call
+      # @see https://github.com/ohmage/server/wiki/
+      # @returns success/fail
+      #
+      def annotation_delete(params = {})
+        request = Ohmage::Request.new(self, :post, 'annotation/delete', params)
+        request.perform
+      end
+    end
+  end
+end

data/lib/ohmage/api.rb

@@ -5,6 +5,7 @@ require 'ohmage/document'
 require 'ohmage/media'
 require 'ohmage/survey'
 require 'ohmage/audit'
+require 'ohmage/annotation'
 
 module Ohmage
   module API
@@ -15,5 +16,6 @@ module Ohmage
     include Ohmage::API::Media
     include Ohmage::API::Survey
     include Ohmage::API::Audit
+    include Ohmage::API::Annotation
   end
 end

data/lib/ohmage/cli.rb

@@ -80,12 +80,12 @@ module Ohmage
       option :class_role, type: :string, desc: 'class_role param: like urn:class:public;reader'
       option :campaign_role, type: :string, desc: 'campaign_role param: like urn:campaign:snack;reader'
       def document(file) # rubocop:disable all
-        case options[:share]
-        when false
-          privacy_state = 'private'
-        else
-          privacy_state = 'shared'
-        end
+        privacy_state = case options[:share]
+                        when false
+                          'private'
+                        else
+                          'shared'
+                        end
         if options[:campaign_role].nil? && options[:class_role].nil?
           puts 'must supply one of [--class_role, --campaign_role]'
         elsif options[:name].nil?

data/lib/ohmage/entity/annotation.rb

@@ -0,0 +1,14 @@
+module Ohmage
+  class Annotation
+    # @return [String]
+    attr_reader :time, :timezone, :annotation_id, :text, :author
+    alias_method :id, :annotation_id
+    alias_method :urn, :annotation_id
+
+    def initialize(attrs = {})
+      attrs.keys[0].each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/ohmage/entity/campaign.rb

@@ -7,7 +7,7 @@ module Ohmage
     attr_reader :user_roles, :classes
     alias_method :roles, :user_roles
     # @return [Hash]
-    attr_reader :user_role_campaign
+    attr_reader :user_role_campaign, :survey_response_count
 
     def initialize(attrs = {})
       @urn = attrs.keys[0].to_s

data/lib/ohmage/entity/survey.rb

@@ -1,7 +1,7 @@
 module Ohmage
   class SurveyResponse
     # @return [String]
-    attr_reader :client, :privacy_state, :repeatable_set_id, :repeatable_set_iteration, :survey_description, :survey_id, :survey_title, :user, :timezone
+    attr_reader :urn, :client, :privacy_state, :repeatable_set_id, :repeatable_set_iteration, :survey_description, :survey_id, :survey_title, :user, :timezone
     # @return [String] location stuffz
     attr_reader :location_accuracy, :location_provider, :location_status, :location_timestamp
     # @return [Long]

data/lib/ohmage/error.rb

@@ -32,7 +32,7 @@ module Ohmage
       502 => Ohmage::Error::BadGateway,
       503 => Ohmage::Error::ServiceUnavailable,
       504 => Ohmage::Error::GatewayTimeout
-    }
+    }.freeze
     # How ugly is this??
     STRING_ERRORS = {
       '0100' => Ohmage::Error::InternalServerError,
@@ -68,35 +68,6 @@ module Ohmage
       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]
@@ -107,5 +78,37 @@ module Ohmage
       super(message)
       @code = code
     end
+
+    # 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
+        # some bug in catchall already sets this?
+        # error class really needs a refactor.
+        new(message)
+      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
   end
 end

data/lib/ohmage/survey.rb

@@ -52,7 +52,7 @@ module Ohmage
       def survey_upload(params = {})
         # loop around params, finding attached images/files, set them as form data.
         params.each do |param|
-          if /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.match(param.first)
+          if /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/ =~ param.first
             @mime_type = /[^;]*/.match(`file -b --mime "#{param[1]}"`)[0]
             params[param[0]] = HTTP::FormData::File.new(param[1], mime_type: @mime_type)
           end

data/lib/ohmage/user.rb

@@ -75,7 +75,7 @@ module Ohmage
       #
       # ohmage user/search call. Admin only api
       # @see https://github.com/ohmage/server/wiki/User-Manipulation#userSetup
-      # @returns Array of Ohmage::User objects. 
+      # @returns Array of Ohmage::User objects.
       #
       def user_search(params = {})
         request = Ohmage::Request.new(self, :post, 'user/search', params)

data/lib/ohmage/version.rb

@@ -14,7 +14,7 @@ module Ohmage
 
     # @return [Integer]
     def patch
-      29
+      31
     end
 
     # @return [Integer, NilClass]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ohmage
 version: !ruby/object:Gem::Version
-  version: 0.0.29
+  version: 0.0.31
 platform: ruby
 authors:
 - Steve Nolen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -77,6 +77,7 @@ files:
 - LICENSE.txt
 - bin/ohmage
 - lib/ohmage.rb
+- lib/ohmage/annotation.rb
 - lib/ohmage/api.rb
 - lib/ohmage/audit.rb
 - lib/ohmage/campaign.rb
@@ -85,6 +86,7 @@ files:
 - lib/ohmage/cli_helpers.rb
 - lib/ohmage/client.rb
 - lib/ohmage/document.rb
+- lib/ohmage/entity/annotation.rb
 - lib/ohmage/entity/audit.rb
 - lib/ohmage/entity/campaign.rb
 - lib/ohmage/entity/clazz.rb