ohmage 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11562ee88ee211a26b1de51f1d85381b7dca6348
-  data.tar.gz: be85538fa68335913b62a27aad4df53255075cc0
+  metadata.gz: 59ab780b8079f500ce47352892b7decd6e1c0ef8
+  data.tar.gz: f7055a09f90ef2c8643c6977a115dae2fbdc9f11
 SHA512:
-  metadata.gz: e15077337892ceccd71a69d8dc6a355b668773f78cabb4ccb8781cb2830d22f1a2037f550c3132d897c4349828672a478179a4625dc9bc6fe8e806e7acebc538
-  data.tar.gz: 8f953a4382d2d9828180a1c1d9c9b38a0713120a6b62141662cf924e1ee400b7abcc190f115199b2eef01ee37d65b24ffb0be20bbf7e78405f2cfb8391bb18a0
+  metadata.gz: df90c35418b29eeea0e4fb2a7ef80c0f11591e363204123fd214a2b5285ce8ce798026d9a66ff866df052363740199aa61e1faf2fc4460db55dac3e4b8d0b5b7
+  data.tar.gz: ba6990e6bb8bb75fb477d405f63dbf85a8057a2be5dc95ce753ef0db4dd112e9d80027748cc7cca315883820ecdc3cf9ab4b7cc0d0be886b37ddade14c7bfbf2

data/lib/ohmage.rb

@@ -7,6 +7,7 @@ require 'ohmage/request'
 require 'ohmage/entity/user'
 require 'ohmage/entity/clazz'
 require 'ohmage/entity/campaign'
+require 'ohmage/entity/document'
 require 'ohmage/version'
 
 module Ohmage

data/lib/ohmage/api.rb

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

data/lib/ohmage/cli.rb

@@ -21,7 +21,7 @@ module Ohmage
         ls = Ohmage.class_read(class_urn_list: urn_list)
         Ohmage::CliHelpers.format_output(ls, options[:table], [:name, :urn, :description, :role, :users], :urn)
       end
-      map :class => :clazz
+      map class: :clazz
 
       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'
@@ -56,7 +56,7 @@ module Ohmage
                                         description: options[:description])
         Ohmage::CliHelpers.format_output(new_class, options[:table], [:urn, :name, :description], :urn)
       end
-      map :class => :clazz
+      map class: :clazz
     end
 
     class Delete < Thor
@@ -64,7 +64,7 @@ module Ohmage
       def clazz(urn)
         Ohmage.class_delete(class_urn: urn)
       end
-      map :class => :clazz
+      map class: :clazz
 
       desc 'delete user <username>', 'deletes an existing ohmage user'
       def user(username)

data/lib/ohmage/document.rb

@@ -0,0 +1,28 @@
+module Ohmage
+  module API
+    module Document
+      #
+      # ohmage document/read call
+      # @see https://github.com/ohmage/server/wiki/Document-Manipulation#document-information-read
+      # @returns [Array: Ohmage::Document objects] matching criteria and output format
+      def document_read(params = {})
+        request = Ohmage::Request.new(self, :post, 'document/read', params)
+        # TODO: make a utility to abstract creation of array of base objects
+        t = []
+        request.perform[:data].each do |k, v|
+          t << Ohmage::Document.new(k => v)
+        end
+        t
+      end
+
+      def document_create(file, params = {})
+        params[:document] = HTTP::FormData::File.new(file)
+        # catch lack of document_name param, since we can just append the filename we have!
+        params[:document_name] = File.basename(file) unless params.key?(:document_name)
+        request = Ohmage::Request.new(self, :post, 'document/create', params)
+        request.perform
+        document_read(document_name_search: params[:document_name])
+      end
+    end
+  end
+end

data/lib/ohmage/entity/document.rb

@@ -0,0 +1,16 @@
+module Ohmage
+  class Document
+    # @return [String]
+    attr_reader :urn, :name, :size, :user_max_role, :user_role, :privacy_state, :last_modified, :description
+    alias_method :id, :urn
+    # @return [Hash]
+    attr_reader :campaign_role, :class_role
+
+    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/request.rb

@@ -14,9 +14,16 @@ module Ohmage
       end
 
       @request_method = request_method
+      # some create/upload apis require content to be sent as multipart form. catch that here
+      case api
+      when 'document/create', 'survey/upload'
+        @params = {form: @options}
+      else
+        @params = {params: @options}
+      end
     end
     def perform # rubocop:disable all
-      response = HTTP.public_send(@request_method, @uri.to_s, params: @options)
+      response = HTTP.public_send(@request_method, @uri.to_s, @params)
       response_body = symbolize_keys!(response.parse)
       response_headers = response.headers
       begin

data/lib/ohmage/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ohmage
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Steve Nolen
@@ -83,8 +83,10 @@ files:
 - lib/ohmage/cli.rb
 - lib/ohmage/cli_helpers.rb
 - lib/ohmage/client.rb
+- lib/ohmage/document.rb
 - lib/ohmage/entity/campaign.rb
 - lib/ohmage/entity/clazz.rb
+- lib/ohmage/entity/document.rb
 - lib/ohmage/entity/user.rb
 - lib/ohmage/error.rb
 - lib/ohmage/request.rb