knuverse-knufactor 0.0.1

data/lib/knuverse/knufactor/resource_collection.rb

@@ -0,0 +1,189 @@
+module KnuVerse
+  module Knufactor
+    # The ResourceCollection class
+    # Should not allow or use mixed types
+    class ResourceCollection
+      include Enumerable
+      include Comparable
+
+      # @return [Class] a collection of this {Resource} subclass
+      attr_reader :type
+
+      def initialize(list, options = {})
+        # TODO: better options validations
+        raise Exceptions::InvalidOptions unless options.is_a?(Hash)
+        raise Exceptions::InvalidArguments if list.empty? && options[:type].nil?
+        @api_client = options[:api_client] || APIClient.instance
+        @list = list
+        @type = options[:type] || list.first.class
+      end
+
+      def each(&block)
+        @list.each(&block)
+      end
+
+      # Does the collection contain anything?
+      # @return [Boolean]
+      def empty?
+        @list.empty?
+      end
+
+      # Provide the first (or first `n`) entries
+      # @param n [Fixnum] How many to provide
+      # @return [ResourceCollection,Resource]
+      def first(n = nil)
+        if n
+          self.class.new(@list.first(n), type: @type, api_client: @api_client)
+        else
+          @list.first
+        end
+      end
+
+      # Provide the last (or last `n`) entries
+      # @param n [Fixnum] How many to provide
+      # @return [ResourceCollection,Resource]
+      def last(n = nil)
+        if n
+          self.class.new(@list.last(n), type: @type, api_client: @api_client)
+        else
+          @list.last
+        end
+      end
+
+      # Merge two collections
+      # @param other [ResourceCollection]
+      # @return [ResourceCollection]
+      def merge(other)
+        raise Exceptions::InvalidArguments unless other.is_a?(self.class)
+        self + (other - self)
+      end
+
+      # An alias for {#type}
+      def model
+        type
+      end
+
+      # Hacked together #or() method in the same spirit as #where().
+      # This method can be chained for multiple / more specific queries.
+      #
+      # @param attribute [Symbol] the attribute to query
+      # @param value [Object] the value to compare against
+      #   - allowed options are "'==', '!=', '>', '>=', '<', '<=', and 'match'"
+      # @raise [Exceptions::InvalidWhereQuery] if not the right kind of comparison
+      # @return [ResourceCollection]
+      def or(attribute, value, options = {})
+        options[:comparison] ||= value.is_a?(Regexp) ? :match : '=='
+        if empty?
+          @type.where(attribute, value, comparison: options[:comparison], api_client: @api_client)
+        else
+          merge first.class.where(
+            attribute, value,
+            comparison: options[:comparison],
+            api_client: @api_client
+          )
+        end
+      end
+
+      # Pass pagination through to the Array (which passes to will_paginate)
+      def paginate(*args)
+        @list.paginate(*args)
+      end
+
+      # Returns the number of Resource instances in the collection
+      # @return [Fixnum]
+      def size
+        @list.size
+      end
+
+      # Allow complex sorting like an Array
+      # @return [ResourceCollection] sorted collection
+      def sort(&block)
+        self.class.new(super(&block), type: @type, api_client: @api_client)
+      end
+
+      # Horribly inefficient way to allow querying Resources by their attributes.
+      # This method can be chained for multiple / more specific queries.
+      #
+      # @param attribute [Symbol] the attribute to query
+      # @param value [Object] the value to compare against
+      #   - allowed options are "'==', '!=', '>', '>=', '<', '<=', and 'match'"
+      # @raise [Exceptions::InvalidWhereQuery] if not the right kind of comparison
+      # @return [ResourceCollection]
+      def where(attribute, value, options = {})
+        valid_comparisons = [:'==', :'!=', :>, :'>=', :<, :'<=', :match]
+        options[:comparison] ||= value.is_a?(Regexp) ? :match : '=='
+        unless valid_comparisons.include?(options[:comparison].to_sym)
+          raise Exceptions::InvalidWhereQuery
+        end
+        self.class.new(
+          @list.collect do |item|
+            if item.send(attribute).nil?
+              nil
+            elsif item.send(attribute).send(options[:comparison].to_sym, value)
+              item
+            end
+          end.compact,
+          type: @type,
+          api_client: @api_client
+        )
+      end
+
+      alias and where
+
+      # Return the collection item at the specified index
+      # @return [Resource,ResourceCollection] the item at the requested index
+      def [](index)
+        if index.is_a?(Range)
+          self.class.new(@list[index], type: @type, api_client: @api_client)
+        else
+          @list[index]
+        end
+      end
+
+      # Return a collection after subtracting from the original
+      # @return [ResourceCollection]
+      def -(other)
+        if other.respond_to?(:to_a)
+          self.class.new(@list - other.to_a, type: @type, api_client: @api_client)
+        elsif other.is_a?(Resource)
+          self.class.new(@list - Array(other), type: @type, api_client: @api_client)
+        else
+          raise Exceptions::InvalidArguments
+        end
+      end
+
+      # Return a collection after adding to the original
+      #   Warning: this may cause duplicates or mixed type joins! For safety,
+      #   use #merge
+      # @return [ResourceCollection]
+      def +(other)
+        if other.is_a?(self.class)
+          self.class.new(@list + other.to_a, type: @type, api_client: @api_client)
+        elsif other.is_a?(@type)
+          self.class.new(@list + [other], type: @type, api_client: @api_client)
+        else
+          raise Exceptions::InvalidArguments
+        end
+      end
+
+      def <<(other)
+        raise Exceptions::InvalidArguments, 'Resource Type Mismatch' unless other.class == @type
+        @list << other
+      end
+
+      def <=>(other)
+        collect(&:id).sort <=> other.collect(&:id).sort
+      end
+
+      # Allow comparison of collection
+      # @return [Boolean] do the collections contain the same resource ids?
+      def ==(other)
+        if other.is_a? self.class
+          collect(&:id).sort == other.collect(&:id).sort
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/knuverse/knufactor/resources/client.rb

@@ -0,0 +1,44 @@
+module KnuVerse
+  module Knufactor
+    module Resources
+      # The Knufactor Client resource
+      #   rubocop:disable Style/ExtraSpacing
+      class Client < Resource
+        property :bypass_expiration
+        property :bypass_limit
+        # @return [Boolean]
+        # @!method bypass_require_code?
+        property :bypass_require_code,    type: :boolean, read_only: true
+        property :bypass_require_pin,     type: :boolean
+        property :bypass_spacing_minutes
+        property :client_id,                              id_property: true
+        property :disable_clients_global, type: :boolean
+        property :email_verified,         type: :boolean, read_only: true
+        property :enroll_date,            type: :time,    read_only: true
+        property :enroll_deadline_date,   type: :time
+        property :enroll_deadline_remaining_minutes
+        property :has_password,           type: :boolean, read_only: true
+        property :has_pin,                type: :boolean, read_only: true
+        property :has_verified,           type: :boolean, read_only: true
+        property :help_tip,                               read_only: true
+        property :is_disabled,            type: :boolean
+        property :is_gauth,               type: :boolean, read_only: true
+        property :is_tenant_client,       type: :boolean, read_only: true
+        property :last_verification_date, type: :time,    read_only: true
+        property :name,                                   read_only: true
+        property :notification,                           read_only: true
+        property :password,                               write_only: true
+        property :password_lock,          type: :boolean
+        property :phone_number_last,                      read_only: true
+        property :pin_rev,                                read_only: true
+        property :role
+        property :role_rationale
+        property :row_doubling
+        property :state,                                  read_only: true
+        property :verification_lock,      type: :boolean
+        property :verification_speed
+        property :verification_speed_floor,               read_only: true
+      end
+    end
+  end
+end

data/lib/knuverse/knufactor/simple_api_client.rb

@@ -0,0 +1,20 @@
+module KnuVerse
+  module Knufactor
+    # The Simple API Client class
+    class SimpleAPIClient < APIClientBase
+      def initialize(opts = {})
+        # validations
+        validate_opts(opts)
+
+        # Set up the client's state
+        @server     = opts[:server] || 'https://cloud.knuverse.com'
+        @apikey     = opts[:apikey]
+        @secret     = opts[:secret]
+        @base_uri   = opts[:base_uri] || '/api/v1/'
+        @last_auth  = nil
+        @auth_token = nil
+        @configured = true
+      end
+    end
+  end
+end

data/lib/knuverse/knufactor/validations/api_client.rb

@@ -0,0 +1,42 @@
+module KnuVerse
+  module Knufactor
+    module Validations
+      # APIClient validation methods
+      module APIClient
+        def validate_creds(opts, exception)
+          raise(exception, 'Must Provide Auth') unless opts.key?(:apikey) && opts.key?(:secret)
+        end
+
+        # Validate the options passed on initialize
+        def validate_opts(opts)
+          e = Exceptions::InvalidOptions
+          raise(e, 'Is not Hash-like') unless opts.respond_to?(:[]) && opts.respond_to?(:key?)
+          validate_server(opts[:server])
+          if opts.key?(:base_uri)
+            begin
+              URI.parse(opts[:base_uri])
+            rescue URI::InvalidURIError => e
+              raise(e, "Invalid base_uri: #{e}")
+            end
+          end
+
+          validate_creds(opts, e)
+          true
+        end
+
+        # Validate the server name provided
+        def validate_server(name)
+          return true unless name # if no name is provided, just go with the defaults
+          valid = name.is_a? String
+          begin
+            u = URI.parse(name)
+            valid = false unless u.class == URI::HTTP || u.class == URI::HTTPS
+          rescue URI::InvalidURIError
+            valid = false
+          end
+          valid || raise(Exceptions::InvalidOptions, 'Invalid server')
+        end
+      end
+    end
+  end
+end

data/lib/knuverse/knufactor/validations/resource.rb

@@ -0,0 +1,17 @@
+module KnuVerse
+  module Knufactor
+    module Validations
+      # Resource validation methods
+      module Resource
+        def validate_mutability
+          raise Exceptions::ImmutableModification if immutable? && @tainted # this shouldn't happen
+        end
+
+        # The 'id' field should not be set manually
+        def validate_id
+          raise Exceptions::NewInstanceWithID if @entity.key?('id') && @tainted
+        end
+      end
+    end
+  end
+end

data/lib/knuverse/knufactor/version.rb

@@ -0,0 +1,10 @@
+module KnuVerse
+  module Knufactor
+    # The current version of the app
+    VERSION = [
+      0, # Major
+      0, # Minor
+      1, # Patch
+    ].join('.')
+  end
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: knuverse-knufactor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Gnagy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: linguistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- jgnagy@knuedge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- knuverse-knufactor.gemspec
+- lib/core_extensions/string/transformations.rb
+- lib/knuverse/knufactor.rb
+- lib/knuverse/knufactor/api_client.rb
+- lib/knuverse/knufactor/api_client_base.rb
+- lib/knuverse/knufactor/api_exception.rb
+- lib/knuverse/knufactor/exceptions/api_client_not_configured.rb
+- lib/knuverse/knufactor/exceptions/immutable_modification.rb
+- lib/knuverse/knufactor/exceptions/invalid_arguments.rb
+- lib/knuverse/knufactor/exceptions/invalid_options.rb
+- lib/knuverse/knufactor/exceptions/invalid_property.rb
+- lib/knuverse/knufactor/exceptions/invalid_where_query.rb
+- lib/knuverse/knufactor/exceptions/missing_path.rb
+- lib/knuverse/knufactor/exceptions/new_instance_with_id.rb
+- lib/knuverse/knufactor/helpers/api_client.rb
+- lib/knuverse/knufactor/helpers/resource.rb
+- lib/knuverse/knufactor/helpers/resource_class.rb
+- lib/knuverse/knufactor/resource.rb
+- lib/knuverse/knufactor/resource_collection.rb
+- lib/knuverse/knufactor/resources/client.rb
+- lib/knuverse/knufactor/simple_api_client.rb
+- lib/knuverse/knufactor/validations/api_client.rb
+- lib/knuverse/knufactor/validations/resource.rb
+- lib/knuverse/knufactor/version.rb
+homepage: https://github.com/KnuVerse/knuverse-knufactor-sdk-ruby
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: Thanks for installing the KnuVerse Knufactor Ruby SDK!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: KnuVerse Knufactor Ruby SDK
+test_files: []