4me-sdk 1.1.2

data/lib/sdk4me/client/multipart.rb

@@ -0,0 +1,75 @@
+require 'cgi'
+require 'mime/types'
+
+# Takes a hash of string and file parameters and returns a string of text
+# formatted to be sent as a multipart form post.
+#
+# Author:: Cody Brimhall <mailto:cbrimhall@ucdavis.edu>
+# Created:: 22 Feb 2008
+module Sdk4me
+  module Multipart
+    VERSION = "1.0.0" unless const_defined?(:VERSION)
+
+    # Formats a given hash as a multipart form post
+    # If a hash value responds to :string or :read messages, then it is
+    # interpreted as a file and processed accordingly; otherwise, it is assumed
+    # to be a string
+    class Post
+      # We have to pretend like we're a web browser...
+      USERAGENT = "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6" unless const_defined?(:USERAGENT)
+      BOUNDARY = '0123456789ABLEWASIEREISAWELBA9876543210' unless const_defined?(:BOUNDARY)
+      CONTENT_TYPE = "multipart/form-data; boundary=#{ BOUNDARY }" unless const_defined?(:CONTENT_TYPE)
+      HEADER = { 'Content-Type' => CONTENT_TYPE, 'User-Agent' => USERAGENT } unless const_defined?(:HEADER)
+
+      def self.prepare_query(params)
+        fp = []
+
+        params.each do |k, v|
+          if v.respond_to?(:path) && v.respond_to?(:read)
+            fp.push(FileParam.new(k, v.path, v.read))
+          else
+            fp.push(StringParam.new(k, v))
+          end
+        end
+
+        # Assemble the request body using the special multipart format
+        query = fp.map{ |p| "--#{BOUNDARY}\r\n#{p.to_multipart}" }.join  + "--#{BOUNDARY}--"
+        return query, HEADER
+      end
+    end
+
+    private
+
+    # Formats a basic string key/value pair for inclusion with a multipart post
+    class StringParam
+      attr_accessor :k, :v
+
+      def initialize(k, v)
+        @k = k
+        @v = v
+      end
+
+      def to_multipart
+        return %(Content-Disposition: form-data; name="#{CGI::escape(k.to_s)}"\r\n\r\n#{v}\r\n)
+      end
+    end
+
+    # Formats the contents of a file or string for inclusion with a multipart
+    # form post
+    class FileParam
+      attr_accessor :k, :filename, :content
+
+      def initialize(k, filename, content)
+        @k = k
+        @filename = filename
+        @content = content
+      end
+
+      def to_multipart
+        # If we can tell the possible mime-type from the filename, use the first in the list; otherwise, use "application/octet-stream"
+        mime_type = MIME::Types.type_for(filename)[0] || MIME::Types["application/octet-stream"][0]
+        return %(Content-Disposition: form-data; name="#{CGI::escape(k.to_s)}"; filename="#{filename}"\r\nContent-Type: #{ mime_type.simplified }\r\n\r\n#{ content }\r\n)
+      end
+    end
+  end
+end

data/lib/sdk4me/client/response.rb

@@ -0,0 +1,119 @@
+module Sdk4me
+  class Response
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+
+    def request
+      @request
+    end
+
+    def response
+      @response
+    end
+    alias_method :raw, :response
+
+    def body
+      @response.body
+    end
+
+    # The JSON value, if single resource is queried this is a Hash, if multiple resources where queried it is an Array
+    # If the response is not +valid?+ it is a Hash with 'message' and optionally 'errors'
+    def json
+      return @json if defined?(@json)
+      # no content, no JSON
+      if @response.code.to_s == '204'
+        data = {}
+      elsif @response.body.blank?
+        # no body, no json
+        data = {message: @response.message.blank? ? 'empty body' : @response.message.strip}
+      end
+      begin
+        data ||= JSON.parse(@response.body)
+      rescue ::Exception => e
+        data = { message: "Invalid JSON - #{e.message} for:\n#{@response.body}" }
+      end
+      # indifferent access to hashes
+      data = data.is_a?(Array) ? data.map(&:with_indifferent_access) : data.with_indifferent_access
+      # empty OK response is not seen as an error
+      data = {} if data.is_a?(Hash) && data.size == 1 && data[:message] == 'OK'
+      # prepend HTTP response code to message
+      data[:message] = "#{response.code}: #{data[:message]}" unless @response.is_a?(Net::HTTPSuccess)
+      @json = data
+    end
+
+    # the error message in case the response is not +valid?+
+    def message
+      @message ||= json.is_a?(Hash) ? json[:message] : nil
+    end
+
+    # +true+ if the server did not respond at all
+    def empty?
+      @response.body.blank?
+    end
+
+    # +true+ if no 'message' is given (and the JSON could be parsed)
+    def valid?
+      message.nil?
+    end
+    alias_method :success?, :valid?
+
+    # retrieve a value from the resource
+    # if the JSON value is an Array a array with the value for each resource will be given
+    # @param keys: a single key or a key-path separated by comma
+    def[](*keys)
+      values = json.is_a?(Array) ? json : [json]
+      keys.each { |key| values = values.map{ |value| value.is_a?(Hash) ? value[key] : nil} }
+      json.is_a?(Array) ? values : values.first
+    end
+
+    # The nr of resources found
+    def size
+      @size ||= message ? 0 : json.is_a?(Array) ? json.size : 1
+    end
+    alias :count :size
+
+    # pagination - per page
+    def per_page
+      @per_page ||= @response.header['X-Pagination-Per-Page'].to_i
+    end
+
+    # pagination - current page
+    def current_page
+      @current_page ||= @response.header['X-Pagination-Current-Page'].to_i
+    end
+
+    # pagination - total pages
+    def total_pages
+      @total_pages ||= @response.header['X-Pagination-Total-Pages'].to_i
+    end
+
+    # pagination - total entries
+    def total_entries
+      @total_entries ||= @response.header['X-Pagination-Total-Entries'].to_i
+    end
+
+    # pagination urls (full paths with server) - relations :first, :prev, :next, :last
+    # Link: <https://api.4me.com/v1/requests?page=1&per_page=25>; rel="first", <https://api.4me.com/v1/requests?page=2&per_page=25>; rel="prev", etc.
+    def pagination_link(relation)
+      # split on ',' select the [url] in '<[url]>; rel="[relation]"', compact to all url's found (at most one) and take the first
+      (@pagination_links ||= {})[relation] ||= @response.header['Link'] && @response.header['Link'].split(/,\s*<?/).map{ |link| link[/^\s*<?(.*?)>?;\s*rel="#{relation.to_s}"\s*$/, 1] }.compact.first
+    end
+
+    # pagination urls (relative paths without server) - relations :first, :prev, :next, :last
+    def pagination_relative_link(relation)
+      (@pagination_relative_links ||= {})[relation] ||= pagination_link(relation) && pagination_link(relation)[/^https?:\/\/[^\/]*(.*)/, 1]
+    end
+
+    # +true+ if the response is invalid because of throttling
+    def throttled?
+      !!(@response.code.to_s == '429' || (message && message =~ /Too Many Requests/))
+    end
+
+    def to_s
+      valid? ? json.to_s : message
+    end
+
+  end
+end

data/lib/sdk4me/client/version.rb

@@ -0,0 +1,5 @@
+module Sdk4me
+  class Client
+    VERSION = '1.1.2'
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: 4me-sdk
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+platform: ruby
+authors:
+- 4me
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SDK for accessing the 4me
+email: developers@4me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 4me-sdk.gemspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/sdk4me.rb
+- lib/sdk4me/ca-bundle.crt
+- lib/sdk4me/client.rb
+- lib/sdk4me/client/attachments.rb
+- lib/sdk4me/client/multipart.rb
+- lib/sdk4me/client/response.rb
+- lib/sdk4me/client/version.rb
+homepage: https://github.com/code4me/4me-sdk-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: The official 4me SDK for Ruby. Provides easy access to the APIs found at
+  https://developer.4me.com
+test_files: []