talis 0.12.0

data/lib/talis/hierarchy/resource.rb

@@ -0,0 +1,159 @@
+module Talis
+  module Hierarchy
+    # Common functionality to Hierarchy resources (Node, Asset)
+    module Resource
+      # The methods defined within this module are available to instances of,
+      # and the class itself that extends Talis::Hierarchy::Resource.
+      module Helpers
+        # @return [String] The hierarchy namespace.
+        attr_accessor :namespace
+        # @return [String] The ID of the resource.
+        attr_reader :id
+        # @return [String] The type of resource.
+        attr_reader :type
+        # @return [Hash] key-value pair attributes belonging to the resource.
+        attr_accessor :attributes
+
+        @new_resource = false
+        @deleted = false
+
+        # Manages the current & stored resource type so resources can be edited/
+        # deleted properly
+        # @param resource_type [String] the new type of the hierarchy resource
+        def type=(resource_type)
+          @original_type = type if persisted?
+          @type = resource_type
+        end
+
+        # Manages the current & stored resource id so resources can be edited/
+        # deleted properly
+        # @param resource_id [String] the new id of the hierarchy resource
+        def id=(resource_id)
+          @original_id = id if persisted?
+          @id = resource_id
+        end
+
+        # The resource type the API thinks the resource has
+        # (if it has been saved)
+        # @return [String]
+        def stored_type
+          persisted? ? @original_type || type : type
+        end
+
+        # The resource id the API thinks the resource has (if it has been saved)
+        # @return [String]
+        def stored_id
+          persisted? ? @original_id || id : id
+        end
+
+        # A boolean indicating if the resource exists in the remote Blueprint
+        # instance
+        # @return [Boolean]
+        def persisted?
+          !(@new_resource || @deleted)
+        end
+
+        protected
+
+        # Query for assets using HTTParty and not blueprint_rb in order to get
+        # around the Swagger limitation of not being able to choose between
+        # AND and IN queries.
+        # @param request_id [String] unique ID for the remote request.
+        # @param namespace [String] the namespace of the hierarchy.
+        # @param opts [Hash] ({}) optional filter and pagination criteria.
+        # @return [Array<Talis::Hierarchy::Asset>] or an empty array if no
+        #   assets are found.
+        # @raise [Talis::ClientError] if the request was invalid.
+        # @raise [Talis::ServerError] if the search failed on the server.
+        # @raise [Talis::ServerCommunicationError] for network issues.
+        def search_assets(request_id, namespace, opts)
+          response = get("/1/#{namespace}/assets",
+                         query: build_query(opts),
+                         headers: {
+                           'X-Request-Id' => request_id,
+                           'Authorization' => "Bearer #{token}"
+                         })
+          convert_to_blueprint_api_client_model(handle_response(response))
+        rescue SocketError
+          raise Talis::ServerCommunicationError
+        end
+
+        def mark_persisted
+          @new_resource = false
+          @deleted = false
+          @original_id = id
+          @original_type = type
+        end
+
+        def mark_deleted
+          @deleted = true
+          @original_id = id
+          @original_type = type
+        end
+
+        private
+
+        def build_query(opts)
+          query = []
+          opts.each do |key, value|
+            if key.to_s.start_with?('filter')
+              filter = key.to_s.gsub('filter_', '')
+              build_collection_query(query, filter, value)
+            else
+              query << [key, value]
+            end
+          end
+          URI.encode_www_form(query)
+        end
+
+        def build_collection_query(params, key, value)
+          filter_key = "filter[#{key.camelize(:lower)}]"
+          if value.is_a? Array
+            value.each do |item|
+              params << [filter_key, item]
+            end
+          elsif value.is_a? Hash
+            build_collection_query_from_hash(params, filter_key, value)
+          else
+            raise ArgumentError, 'filter value must be an array or hash'
+          end
+        end
+
+        def build_collection_query_from_hash(params, key, hash)
+          mode = hash.keys.first
+          values = hash.values.first
+          if mode == :all
+            values.each do |item|
+              params << [key, item]
+            end
+          else
+            params << [key, values.join(',')]
+          end
+        end
+
+        def convert_to_blueprint_api_client_model(response)
+          response['data'].map! do |item|
+            OpenStruct.new(type: item['type'], id: item['id'],
+                           attributes: item.fetch('attributes', {}))
+          end
+        end
+
+        def configure_blueprint
+          BlueprintClient.configure do |config|
+            config.scheme = base_uri[/https?/]
+            config.host = base_uri
+            config.access_token = token
+          end
+        end
+      end
+
+      # Callback invoked whenever the receiver is included in another module or
+      # class. Receiver here is whoever includes Resource
+      def self.included(base)
+        base.extend(Helpers)
+      end
+
+      include Helpers
+    end
+  end
+end

data/lib/talis/oauth_service.rb

@@ -0,0 +1,18 @@
+module Talis
+  # Allows an individual primitive service to set its own Persona environment
+  module OAuthService
+    attr_accessor :oauth_host, :client_id, :client_secret
+
+    protected
+
+    # Overrides Talis::Resource.token
+    def token
+      options = {
+        client_id: client_id || Talis::Authentication.client_id,
+        client_secret: client_secret || Talis::Authentication.client_secret
+      }
+      options[:host] = oauth_host if oauth_host
+      Talis::Authentication::Token.generate(options)
+    end
+  end
+end

data/lib/talis/resource.rb

@@ -0,0 +1,68 @@
+require 'httparty'
+require 'ostruct'
+require 'securerandom'
+
+module Talis
+  # Extend this class when in order to interact with Talis HTTP APIs.
+  # Each sub class should set base_uri to whatever Talis primitive it needs
+  # to talk to.
+  class Resource
+    include HTTParty
+    format :json
+    headers 'User-Agent' => "talis-ruby-client/#{Talis::VERSION} "\
+      "ruby/#{RUBY_VERSION}"
+
+    class << self
+      def handle_response(response, expected_status_code = 200)
+        if response.code == expected_status_code
+          response.parsed_response
+        elsif response.code >= 400 && response.code < 500
+          build_client_error(response)
+        elsif response.code >= 500
+          raise Talis::ServerError
+        else
+          raise Talis::ServerCommunicationError
+        end
+      end
+
+      def new_req_id
+        SecureRandom.hex(13)
+      end
+
+      protected
+
+      def token
+        options = {
+          client_id: Talis::Authentication.client_id,
+          client_secret: Talis::Authentication.client_secret
+        }
+        Talis::Authentication::Token.generate(options)
+      end
+
+      private
+
+      def build_client_error(response)
+        raise client_errors[response.code], safe_error_description(response)
+      end
+
+      def client_errors
+        errors = {
+          400 => Talis::BadRequestError,
+          401 => Talis::UnauthorizedError,
+          403 => Talis::ForbiddenError,
+          404 => Talis::NotFoundError,
+          409 => Talis::ConflictError
+        }
+        errors.default = Talis::ClientError
+        errors
+      end
+
+      def safe_error_description(response)
+        if response.respond_to? :parsed_response
+          parsed_response = response.parsed_response
+        end
+        parsed_response['error_description'] if parsed_response.present?
+      end
+    end
+  end
+end

data/lib/talis/user.rb

@@ -0,0 +1,112 @@
+require 'active_support'
+require 'talis/authentication/token'
+
+module Talis
+  # Represents a user known by Talis.
+  class User < Talis::Resource
+    base_uri Talis::PERSONA_HOST
+    # @return [String] the globally unique identifier for the user.
+    attr_reader :guid
+    # @return [String] the user's first name.
+    attr_reader :first_name
+    # @return [String] the user's surname.
+    attr_reader :surname
+    # @return [String] the user's E-mail address.
+    attr_reader :email
+    # @return [Talis::Authentication::Token] to use for user authentication
+    #   with other Talis primitive services.
+    attr_reader :token
+
+    private_class_method :new
+
+    # Creates a new user object. For internal use only, use {User.build}.
+    # @param guid [String] the globally unique identifier for the user.
+    # @param first_name [String] the user's first name.
+    # @param surname [String] the user's surname.
+    # @param email [String] the user's E-mail address.
+    # @param token [Talis::Authentication::Token] (nil) valid user token.
+    def initialize(guid:, first_name:, surname:, email:, token: nil)
+      @guid = guid
+      @first_name = first_name
+      @surname = surname
+      @email = email
+      @token = token
+    end
+
+    # Return the combination of the user's first and surname.
+    # @return [String] the user's full name
+    def full_name
+      "#{@first_name} #{@surname}"
+    end
+
+    # Returns a URL that will resolve to an avatar image belonging to the
+    # user when fetched. This URL is cached by browsers when called.
+    # @param size [Integer] (nil) size in pixels (defaults to 70x70).
+    # @param colour [String] (nil) background hex colour (defaults to 000000).
+    # @return [String] the URL of the user's avatar.
+    def avatar_url(size: nil, colour: nil)
+      if size.present? && colour.present?
+        params = "?#{URI.encode_www_form(size: size, colour: colour)}"
+      elsif size.present?
+        params = "?#{URI.encode_www_form(size: size)}"
+      elsif colour.present?
+        params = "?#{URI.encode_www_form(colour: colour)}"
+      end
+      "#{self.class.base_uri}/users/#{guid}/avatar#{params}"
+    end
+
+    class << self
+      # Find a single user given the search criterion.
+      # In order to perform this search, the client must be configured with a
+      # valid OAuth client that is allowed to search for users:
+      #
+      #  Talis::Authentication.client_id = 'client_id'
+      #  Talis::Authentication.client_secret = 'client_secret'
+      #
+      # @param request_id [String] ('uuid') unique ID for the remote request.
+      # @param guid [String] the globally unique ID of the user to find.
+      # @return [User]
+      def find(request_id: new_req_id, guid:)
+        response = get("/users/#{guid}",
+                       headers: {
+                         'X-Request-Id' => request_id,
+                         'Authorization' => "Bearer #{token}"
+                       })
+        new(extract_user_data(handle_response(response)))
+      rescue Talis::NotFoundError
+        nil
+      end
+
+      # Builds a new user object. This is for creating user objects as a
+      # result of a successful login request.
+      # @param guid [String] the globally unique identifier for the user.
+      # @param first_name [String] the user's first name.
+      # @param surname [String] the user's surname.
+      # @param email [String] the user's E-mail address.
+      # @param access_token [String] (nil) valid user JWT.
+      # @return [User]
+      def build(guid:, first_name:, surname:, email:, access_token: nil)
+        options = {
+          guid: guid,
+          first_name: first_name,
+          surname: surname,
+          email: email,
+          token: Talis::Authentication::Token.new(jwt: access_token)
+        }
+        new(options)
+      end
+
+      private
+
+      def extract_user_data(data)
+        profile = data.fetch('profile', {})
+        {
+          guid: data['guid'],
+          first_name: profile['first_name'],
+          surname: profile['surname'],
+          email: profile['email']
+        }
+      end
+    end
+  end
+end

data/lib/talis/version.rb

@@ -0,0 +1,3 @@
+module Talis
+  VERSION = '0.12.0'.freeze
+end

data/talis.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'talis/version'
+
+# rubocop:disable Metrics/LineLength
+Gem::Specification.new do |spec|
+  spec.name          = 'talis'
+  spec.version       = Talis::VERSION
+  spec.authors       = ['Omar Qureshi', 'Ben Paddock']
+  spec.email         = ['oq@talis.com', 'bp@talis.com']
+
+  spec.summary       = 'Ruby client to utilise Talis primitive services'
+  spec.homepage      = 'https://github.com/talis/talis_rb'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'uuid', '2.3.8'
+  spec.add_dependency 'jwt', '1.5.4'
+  spec.add_dependency 'activesupport', '~> 4.2.6'
+  spec.add_dependency 'httparty', '0.13.7'
+  spec.add_dependency 'multi_json', '1.11.2'
+  spec.add_dependency 'blueprint_ruby_client', '~> 0.5.2'
+  spec.add_dependency 'metatron_ruby_client', '~> 0.1.3'
+
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-wait'
+  spec.add_development_dependency 'rubocop', '~> 0.39.0'
+  spec.add_development_dependency 'webmock', '~> 1.24.2'
+end

metadata

@@ -0,0 +1,327 @@
+--- !ruby/object:Gem::Specification
+name: talis
+version: !ruby/object:Gem::Version
+  version: 0.12.0
+platform: ruby
+authors:
+- Omar Qureshi
+- Ben Paddock
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: blueprint_ruby_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: metatron_ruby_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: dotenv
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-wait
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+description: 
+email:
+- oq@talis.com
+- bp@talis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/talis.rb
+- lib/talis/analytics.rb
+- lib/talis/analytics/event.rb
+- lib/talis/authentication.rb
+- lib/talis/authentication/client.rb
+- lib/talis/authentication/login.rb
+- lib/talis/authentication/public_key.rb
+- lib/talis/authentication/token.rb
+- lib/talis/bibliography.rb
+- lib/talis/bibliography/ebook.rb
+- lib/talis/bibliography/manifestation.rb
+- lib/talis/bibliography/result_set.rb
+- lib/talis/bibliography/work.rb
+- lib/talis/constants.rb
+- lib/talis/errors.rb
+- lib/talis/errors/authentication_failed_error.rb
+- lib/talis/errors/client_errors.rb
+- lib/talis/errors/server_communication_error.rb
+- lib/talis/errors/server_error.rb
+- lib/talis/extensions/object.rb
+- lib/talis/feeds.rb
+- lib/talis/feeds/annotation.rb
+- lib/talis/feeds/feed.rb
+- lib/talis/hierarchy.rb
+- lib/talis/hierarchy/asset.rb
+- lib/talis/hierarchy/node.rb
+- lib/talis/hierarchy/resource.rb
+- lib/talis/oauth_service.rb
+- lib/talis/resource.rb
+- lib/talis/user.rb
+- lib/talis/version.rb
+- talis.gemspec
+homepage: https://github.com/talis/talis_rb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby client to utilise Talis primitive services
+test_files: []