itrp-client 1.0.0

data/lib/itrp/client/response.rb

@@ -0,0 +1,114 @@
+module Itrp
+  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 body, no json
+      data = {message: @response.message.blank? ? 'empty body' : @response.message.strip} if @response.body.blank?
+      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.nil?
+    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.itrp.com/v1/requests?page=1&per_page=25>; rel="first", <https://api.itrp.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/itrp/client/version.rb

@@ -0,0 +1,5 @@
+module Itrp
+  class Client
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: itrp-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ITRP
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-20 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: mime-types
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !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: Client for accessing the ITRP REST API
+email: developers@itrp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/itrp/ca-bundle.crt
+- lib/itrp/client.rb
+- lib/itrp/client/version.rb
+- lib/itrp/client/response.rb
+- lib/itrp/client/multipart.rb
+- lib/itrp/client/attachments.rb
+- lib/itrp.rb
+- LICENSE.txt
+- README.md
+- Gemfile
+- Gemfile.lock
+- itrp-client.gemspec
+homepage: https://developer.itrp.com
+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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Client for accessing the ITRP REST API
+test_files: []