knuverse-knufactor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 224e08737aef33c81546244ee7b5c61ee4dee62d
+  data.tar.gz: abd0db60daee18081303470062a4f120b5300e0c
+SHA512:
+  metadata.gz: bbc6a2bdc236889d73413e8ebc55b0de64404c457eb522c028f217000f7de000d82088af673bf998a2fe08569864002d7cc43f81838cfcec234fee366bf260a2
+  data.tar.gz: 5c7d09db089ebf5517c98a3c97a145e134c627f8ca551954318cbb231d6e78cb2358330835c28b66c09d51a508180c370ae448443ebc3851183380f5cb14d76f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+# Ignore Mac stuff
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 22
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 10

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+- 2.1.10
+- 2.2.5
+- 2.3.1
+cache: bundler
+deploy:
+  provider: rubygems
+  api_key:
+    secure: A9iVmtSsR9iJsjGMXfKHNVuZn13QVdnnRAmAwXQvCSXmDaZQyHLejYnAGQ3WjZc2XbLxSn/787MUTJC2yxG9pJy+Nnyr6L9ZtoBD3F5/q+iqklJXIXtuVV/wOcknG+m71kEIIntZv+g2hVjHo/CfAbm10ycqlJDw/MMoPGxkwXHkj9qGEft6jXygzGEDGxnmqyBRAHZ/BI0vjojdTLM8yO/0RFF1X2cs55YRGyicmE8V/ZYwL5cOVfwCqYNtVp4Pce4GxWfX+Dp1PceI4jnX9hq/kMa+0mTkLWPdMQLYVjyIaZ7eso8RQb9yVPdIGZKp2vQqN1t+s/EHgmiriv/tHluvLnIWjHIwYFuX0Bd9wttp7Sb1K7HhqP0T/Ymny41KLr4Nnx3PqIcm9dz57x6zvq1bIykVlG3sZNthVPKAwbX6lj6X/HCyYaDr65EwFPDWsOxt78zJdbZuV0pdg4rEJaF8MHKy3lOfwm52AfIC4iMsnshhSylDETjwG7P556ZHzutODB3JPSKwmJriGihVBiG5V5TpdrPD9oZPs6rg8XWZs9bdhroIk9FcfE5MZJ0UDUdcV3dpcdJI109G3SR2rxSHaozfeaggsBa4QMD9gPP+Tx2DiD4eOntxo3zhoylISeKIJptLEOqz+vPEWcj/J25+iXbotvlFB1khibVWn0c=
+  gem: knuverse-knufactor
+  on:
+    tags: true

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+## Welcome!
+
+We're so glad you're thinking about contributing to a KnuEdge open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.
+
+We want to ensure a welcoming environment for all of our projects. Our IT staff encourage ethical contribution to our open source projects and all contributors should do the same.
+
+We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE), and its [README](README.md).
+
+If you have any questions just [shoot us an email](mailto:opensource@knuedge.com).
+
+## Licensing
+
+This project and all code contained within it are released under the [MIT License](https://opensource.org/licenses/MIT).
+
+All contributions to this project will be released under the [MIT License](https://opensource.org/licenses/MIT). By submitting a pull request, you are agreeing to comply
+with this license and for any contributions to be released under it.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knuverse-knufactor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 KnuEdge
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+The KnuVerse Knufactor SDK for Ruby
+====================
+
+About
+----
+This project is a Ruby SDK that allows developers to create apps that use Knuverse's Knufactor Cloud APIs.
+
+Documentation for the API can be found [here](https://cloud.knuverse.com/docs/)
+
+Note that this SDK isn't a direct port of the [Python SDK](https://github.com/KnuVerse/knuverse-sdk-python), though it is based heavily on the work done there. This SDK uses a Object-Oriented pattern, which is likely more familiar to Ruby developers than a collection of functions may be.
+
+Building and Installing
+----
+Building the gem requires a modern Ruby:
+
+    # highly recommend using RVM here, and Ruby 2.x or above
+    gem build knuverse-knufactor.gemspec
+    # install what you just built
+    gem install knuverse-knufactor-*.gem
+
+That said, recent releases should be available on [rubygems.org](https://rubygems.org/) so building is probably not necessary.
+
+Just add the following to your Gemfile:
+
+    gem 'knuverse/knufactor'
+
+Then run:
+
+    bundle install
+
+If you're not using [bundler](http://bundler.io/) for some reason (shame on you!), you can manually install like so:
+
+    gem install knuverse-knufactor
+
+If you see a message like this:
+
+    Thanks for installing the KnuVerse Knufactor Ruby SDK!
+
+You should be all set!
+
+Usage
+------
+Check back, because this file will be updated with a lot more usage examples.
+
+For a typical custom ruby application, you'll need to do something like the following to get started:
+
+```ruby
+require 'knuverse/knufactor'
+
+# configure the API client singleton
+KnuVerse::Knufactor::APIClient.configure(
+  apikey: 'b1b71d68cffea1d43257fff9deadbeef',
+  secret: '34d04e5f05a194444e9c26358a94eaf2'
+)
+```
+
+From here, the SDK will automatically rely on this configuration singleton unless you tell it otherwise. Here are some examples of interacting with the API:
+
+```ruby
+# pull some data
+KnuVerse::Knufactor::APIClient.about_service
+# => {"company"=>"KnuVerse", "version"=>"1.4.0", "multi_tenant"=>true, "service"=>"audiopin", "name"=>"KnuVerse"}
+
+# Make working with resources easier
+include KnuVerse::Knufactor::Resources
+
+# Find some clients
+clients = Client.all
+
+# Take a look at the last client
+client = clients.last
+client.name
+# => "user75"
+
+# Make a change
+client.bypass_limit = 10
+
+# Now persist it
+client.save
+
+# Verify the change worked
+client.reload
+client.bypass_limit
+# => 10
+
+# Find some specific clients... all locked out clients
+locked_clients = Client.where(:password_lock?, true)
+# => #<KnuVerse::Knufactor::ResourceCollection:...
+
+# Find clients that are either enrolled or installed
+happy_clients = Client.where(:state, 'enrolled').or(:state, 'installed')
+
+# Find clients with a name that starts with "z"
+z_clients = Client.where(:name, /^z/i)
+```
+
+For some more complex situations, you may want a specialized API Client (interact with it as an instance, or have a thread-local or context-specific client):
+
+```ruby
+# interact with the singleton as a client instance for simplicity
+api_client = KnuVerse::Knufactor::APIClient.instance
+
+# In complex, multi-user systems, using a singleton class might not work.
+# For this reason, there is a regular class version of the API client that is not tied to the singleton
+local_api_client1 = KnuVerse::Knufactor::SimpleAPIClient.new(
+  apikey: 'b1b71d68cffea1d43257fff9deadbeef', secret: '57838344acf7f5876226ede247c5881a'
+)
+local_api_client2 = KnuVerse::Knufactor::SimpleAPIClient.new(
+  apikey: '33371d68cffea1d43257fff9deadf00d', secret: 'e7d1c88825dc96a05bc38c39cca4a1ca'
+)
+local_api_client1 == local_api_client2
+# => false
+
+# Perform an operation with a specific instance of the API Client
+Client.all(api_client: local_api_client1)
+# All finder methods work this way, allowing the 'api_client' option to be passed
+Client.where(:name, 'bobby', api_client: local_api_client2)
+
+```
+
+License
+-------
+This project and all code contained within it are released under the [MIT License](https://opensource.org/licenses/MIT). As stated in [CONTRIBUTING](CONTRIBUTING.md):
+
+> All contributions to this project will be released under the [MIT License](https://opensource.org/licenses/MIT). By submitting a pull request, you are agreeing to comply with this license and for any contributions to be released under it.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new
+
+task default: [:spec, :rubocop, :yard]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'knuverse/knufactor'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/knuverse-knufactor.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knuverse/knufactor/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'knuverse-knufactor'
+  spec.version       = KnuVerse::Knufactor::VERSION
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.authors       = ['Jonathan Gnagy']
+  spec.email         = ['jgnagy@knuedge.com']
+
+  spec.summary       = 'KnuVerse Knufactor Ruby SDK'
+  spec.homepage      = 'https://github.com/KnuVerse/knuverse-knufactor-sdk-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.metadata['yard.run'] = 'yri'
+
+  spec.required_ruby_version = '~> 2.0'
+  spec.post_install_message  = 'Thanks for installing the KnuVerse Knufactor Ruby SDK!'
+  spec.platform              = Gem::Platform::RUBY
+
+  spec.add_runtime_dependency 'linguistics', '~> 2.1'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0'
+  spec.add_runtime_dependency 'will_paginate', '~> 3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rubocop', '~> 0.35'
+  spec.add_development_dependency 'yard',    '~> 0.8'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'travis', '~> 1.8'
+end

data/lib/core_extensions/string/transformations.rb

@@ -0,0 +1,28 @@
+module CoreExtensions
+  module String
+    # Monkey-patches for String to add some simple missing transformations
+    module Transformations
+      # Convert CamelCase to underscored_text
+      # @return [String]
+      def to_underscore
+        gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+      end
+
+      # Convert underscored_text to CamelCase
+      # @return [String]
+      def to_camel
+        split('_').map(&:capitalize).join
+      end
+
+      # Attempt to guess a more human-like view of a string
+      # @return [String]
+      def humanize
+        gsub(/_id$/, '').tr('_', ' ').capitalize
+      end
+    end
+  end
+end

data/lib/knuverse/knufactor.rb

@@ -0,0 +1,42 @@
+# Standard Library Requirements
+require 'json'
+require 'singleton'
+
+# External Library Requirements
+require 'linguistics'
+Linguistics.use(:en)
+require 'rest-client'
+require 'will_paginate'
+require 'will_paginate/array'
+
+# Internal Requirements
+require 'core_extensions/string/transformations'
+String.include CoreExtensions::String::Transformations
+
+require 'knuverse/knufactor/version'
+require 'knuverse/knufactor/api_exception'
+require 'knuverse/knufactor/exceptions/api_client_not_configured'
+require 'knuverse/knufactor/exceptions/immutable_modification'
+require 'knuverse/knufactor/exceptions/invalid_arguments'
+require 'knuverse/knufactor/exceptions/invalid_options'
+require 'knuverse/knufactor/exceptions/invalid_property'
+require 'knuverse/knufactor/exceptions/invalid_where_query'
+require 'knuverse/knufactor/exceptions/missing_path'
+require 'knuverse/knufactor/exceptions/new_instance_with_id'
+require 'knuverse/knufactor/helpers/api_client'
+require 'knuverse/knufactor/validations/api_client'
+require 'knuverse/knufactor/api_client_base'
+require 'knuverse/knufactor/api_client'
+require 'knuverse/knufactor/simple_api_client'
+require 'knuverse/knufactor/resource_collection'
+require 'knuverse/knufactor/helpers/resource'
+require 'knuverse/knufactor/helpers/resource_class'
+require 'knuverse/knufactor/validations/resource'
+require 'knuverse/knufactor/resource'
+require 'knuverse/knufactor/resources/client'
+
+module KnuVerse
+  # The SDK for interacting with the KnuVerse Knufactor Cloud API
+  module Knufactor
+  end
+end

data/lib/knuverse/knufactor/api_client.rb

@@ -0,0 +1,30 @@
+module KnuVerse
+  module Knufactor
+    # The API Client Singleton class
+    class APIClient < APIClientBase
+      include Singleton
+
+      def self.configure(opts = {})
+        instance.configure(opts)
+      end
+
+      def self.about_service
+        instance.about_service
+      end
+
+      def configure(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/api_client_base.rb

@@ -0,0 +1,112 @@
+module KnuVerse
+  module Knufactor
+    # The API Client Base class
+    class APIClientBase
+      attr_reader :server, :base_uri
+      attr_accessor :apikey, :secret, :account
+
+      include Validations::APIClient
+      include Helpers::APIClient
+
+      def about_service
+        get 'about'
+      end
+
+      def api_uri
+        @api_uri ||= URI.parse(server)
+        @api_uri.path = base_uri
+        @api_uri
+      end
+
+      def authenticated?
+        raise Exceptions::APIClientNotConfigured unless configured?
+        @auth_token && @last_auth && ((Time.now.utc - @last_auth) < (60 * 14)) ? true : false
+      end
+
+      def configured?
+        @configured ? true : false
+      end
+
+      def json_headers
+        base = { content_type: :json, accept: :json }
+        authenticated? ? base.merge(authorization: auth_header) : base
+      end
+
+      def refresh_auth_bearer
+        auth_data = {
+          key_id: @apikey,
+          secret: @secret
+        }
+        resp = post('auth', auth_data)
+        resp['jwt']
+      end
+
+      def refresh_auth
+        @auth_token = refresh_auth_bearer
+        @last_auth  = Time.now.utc
+        true
+      end
+
+      def get(uri, data = nil)
+        refresh_auth unless authenticated?
+
+        client_action do |client|
+          if data
+            JSON.parse client[uri].get(json_headers.merge(params: data))
+          else
+            JSON.parse client[uri].get(json_headers)
+          end
+        end
+      end
+
+      def post(uri, data = nil)
+        refresh_auth unless authenticated? || uri == 'auth'
+
+        client_action do |client|
+          if data
+            JSON.parse client[uri].post(json_escape(data.to_json), json_headers)
+          else
+            JSON.parse client[uri].post(nil, json_headers)
+          end
+        end
+      end
+
+      def patch(uri, data)
+        refresh_auth unless authenticated?
+
+        client_action do |client|
+          response = client[uri].patch(json_escape(data.to_json), json_headers)
+          if response && !response.empty?
+            JSON.parse(response)
+          else
+            true
+          end
+        end
+      end
+
+      def put(uri, data)
+        refresh_auth unless authenticated?
+
+        client_action do |client|
+          client[uri].put(json_escape(data.to_json), json_headers)
+        end
+      end
+
+      private
+
+      def auth_header
+        authenticated? ? "Bearer #{@auth_token}" : nil
+      end
+
+      def client_action
+        raise Exceptions::APIClientNotConfigured unless configured?
+        yield connection
+      end
+
+      # Don't bother creating a connection until we need one
+      def connection
+        @connection ||= RestClient::Resource.new(api_uri.to_s)
+      end
+    end
+  end
+end