sfkb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fe296d4e57e23a2b3b1aa70da575f8fec6e8d5d7b0584e46209b202af5fcb36
+  data.tar.gz: 11771d874f39e8a1f80cd98ce90f578cbf7d8c0d3653f9c10981725cb542922a
+SHA512:
+  metadata.gz: 3bb0f074fd40c5fc50ec0696c7d8b5de4d846571cf48921aabe889ab994adac32702f342ba9e2a4fb57e47ca4ba6f45b84750f1861bfd87e51bcb64a107d9655
+  data.tar.gz: dd1f38d22b8a373491f7a3c72b3d6ddad8be5794574368e529a493761ece1c2dd51f5ac74c8a5240794cf1de8af9e89b7d0d7ba4d8f1f5cfb4133a8441013a2a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 JJ Buckley
+
+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,106 @@
+# SFKB
+
+SalesForce Knowledge Base
+
+A Ruby library that extends [Restforce][] to provide convenient access to
+Articles and ArticlesVersions in the Salesforce Knowledge Base.
+
+[![Build Status](https://travis-ci.org/bjjb/sfkb.svg?branch=master)](https://travis-ci.org/bjjb/sfkb)
+
+## Requirements
+
+- [Ruby][]
+- [SalesForce][]
+
+## Installation
+
+    gem install sfkb
+
+## Usage
+
+Include it in your project, for example in your Gemfile
+
+```ruby
+gem 'sfkb'
+```
+
+or just require it.
+
+Now you can use the module as a client, or do something fancier by
+instantiating a `SFKB::Client`.
+
+For example, here's how to print the titles of the master versions of the
+first 10 documents:
+
+```
+require 'sfkb'
+SFKB.new.articles.take(10).each { |a| puts a.OnlineMasterVersion.data.Title }
+```
+
+Here's how to list the titles of every translation of every draft article:
+```
+sf = SFKB.new
+sf.articles.select(:hasTranslations?) do |a|
+    sf.translations(a, 'Draft').each do |t|
+        puts t.data.Title
+    end
+end
+```
+
+Documentation is available [here][docs].
+
+You will need to register an app in your Salesforce instance so you can obtain
+your `SALESFORCE_CLIENT_ID` and `SALESFORCE_CLIENT_SECRET` (see below).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/bjjb/sfkb. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Testing
+
+When testing, you'll want to preconfigure your environment with these
+settings:
+
+- `SALESFORCE_CLIENT_ID`
+- `SALESFORCE_CLIENT_SECRET`
+
+You might also want to set the following (which defaults to
+'login.salesforce.com) to something like 'company.my.salesforce.com', or
+'test.salesforce.com' if you want to use a sandbox.
+
+- `SALESFORCE_HOST`
+
+For authentication, you may either use the username/password/token-secret
+combination:
+
+- `SALESFORCE_USERNAME`
+- `SALESFORCE_PASSWORD`
+- `SALESFORCE_SECURITY_TOKEN`
+
+or
+
+- `SALESFORCE_OAUTH_TOKEN`
+- `SALESFORCE_REFRESH_TOKEN`
+
+the latter of which is optional, and can (and probably should) be set using
+the [`authentication_callback`][1]. For more details, see [Restforce][].
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Glinga project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://gitlab.com/bjjb/glinga/blob/master/CODE_OF_CONDUCT.md).
+
+[Restforce]: https://github.com/restforce/restforce
+[Ruby]: https://ruby-lang.org
+[Salesforce]: https://salesforce.com
+[docs]: http://www.rubydoc.info/github/bjjb/sfkb
+[1]: https://github.com/restforce/restforce#oauth-token-authentication

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/byebug

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'byebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("byebug", "byebug")

data/bin/coderay

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coderay", "coderay")

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sfkb"
+
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/dotenv

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'dotenv' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("dotenv", "dotenv")

data/bin/listen

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'listen' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("listen", "listen")

data/bin/pry

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("pry", "pry")

data/bin/rackup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rack", "rackup")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rerun

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rerun' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rerun", "rerun")

data/bin/safe_yaml

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'safe_yaml' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("safe_yaml", "safe_yaml")

data/bin/setup

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

data/bin/sfkb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'sfkb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sfkb", "sfkb")

data/exe/sfkb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'sfkb'
+
+begin
+  h = SFKB.new.authenticate!
+  puts 'Everything seems OK... here is an access token'
+  puts h.access_token
+rescue
+  puts "Error contacting Salesforce. Check your credentials. See here:"
+  puts "https://github.com/bjjb/sfkb"
+end

data/lib/sfkb.rb

@@ -0,0 +1,13 @@
+require 'restforce'
+require 'dotenv/load'
+
+# A helper library for using the Salesforce Knowledge base in Ruby.
+module SFKB
+  autoload :Knowledge, 'sfkb/knowledge'
+  autoload :Client, 'sfkb/client'
+  autoload :REST, 'sfkb/rest'
+
+  def self.new(*args)
+    Client.new(*args)
+  end
+end

data/lib/sfkb/client.rb

@@ -0,0 +1,11 @@
+require 'restforce/data/client'
+require 'sfkb/rest'
+require 'sfkb/knowledge'
+
+# An SFKB::Client is an object with a connection to salesforce that can lookup
+# KnowledgeArticles and KnowledgeArticleVersions using the Salesforce REST
+# API.
+class SFKB::Client < Restforce::Data::Client
+  include SFKB::REST
+  include SFKB::Knowledge
+end

data/lib/sfkb/decoration.rb

@@ -0,0 +1,39 @@
+module SFKB
+  # Methods to smartly apply singleton methods to REST objects
+  module Decoration
+    def decorate(object)
+      return object unless block_given?
+      yield object
+      object
+    end
+
+    def define_link(object, name, url, &block)
+      getter = -> (url) { get(url).body }
+      decorator = -> (o) { decorate(o, &block) }
+      object.define_singleton_method(name) { decorator.call(getter.call(url)) }
+    end
+
+    def define_links(object, urls, &block)
+      urls.each { |k, v| define_link(object, k, v, &block) }
+    end
+
+    def define_predicate(object, name, value)
+      object.define_singleton_method(:"#{name}?") { value }
+    end
+
+    def autodefine(object)
+      return unless object.respond_to?(:additionalInformation)
+      return unless info = object.additionalInformation
+      info.each do |k, v|
+        if [true, false].include?(v)
+          define_predicate(object, k, v)
+        elsif k.to_s == 'data'
+          define_link(object, :data, v)
+        elsif k.to_s == 'urls'
+          define_links(object, v) { |o| autodefine(o) }
+        end
+      end
+      object
+    end
+  end
+end

data/lib/sfkb/knowledge.rb

@@ -0,0 +1,32 @@
+require 'sfkb/rest'
+require 'sfkb/settings'
+require 'sfkb/decoration'
+
+module SFKB
+  module Knowledge
+    include REST
+    include Settings
+    include Decoration
+
+    # Queries for all (undeleted) article IDs, returning an array.
+    def article_ids
+      query('SELECT Id FROM KnowledgeArticle').map(&:Id)
+    end
+
+    # Enumerates articles
+    def articles
+      Enumerator.new do |y|
+        article_ids.each do |id|
+          y << article(id)
+        end
+      end
+    end
+
+    # Gets an article by ID
+    def article(id)
+      url = index.knowledgeManagement.articles.article
+      url = url(url, ArticleID: id)
+      decorate(get(url).body) { |o| autodefine(o) }
+    end
+  end
+end

data/lib/sfkb/rest.rb

@@ -0,0 +1,52 @@
+module SFKB
+  # Some REST helpers
+  module REST
+    # Used to interpolate variables into REST endpoint URIs
+    @@placeholder = /[<{](.+?)[>}]/
+
+    # { a: :b }.inject({}, &@@stringify) #=> { 'a' => :b }
+    @@stringify = lambda do |collector, kv|
+      collector.tap { |h| h[kv[0].to_s] = kv[1] }
+    end
+
+    # { a: 1 }.delete(:b, &@@required) # raises 'missing param: b'
+    @@required = -> (s) { raise(ArgumentError, "missing param: <#{s}>") }
+
+    # { a: b, c: d }.inject('x', &@@parameterize) #=> 'x?a=b&c=d'
+    @@parameterize = lambda do |s, kv|
+      k, *vs = *kv
+      params = vs.flatten.map { |v| [k, v].join('=') }
+      [s, params].flatten.compact.reject(&:empty?).join('&')
+    end
+
+    # Converts a path and params to a Salesforce-suitable URL.
+    def url(path, params = {})
+      params = params.inject({}, &@@stringify)
+      path = path.gsub(@@placeholder) { params.delete($1, &@@required) }
+      params = params.inject('', &@@parameterize)
+      [path, params].reject(&:nil?).reject(&:empty?).join('?')
+    end
+
+    # The REST API starts here
+    def index
+      endpoint("/services/data/v#{options[:api_version]}") do |k, v|
+        endpoint(v) { |k, v| endpoint(v) }
+      end
+    end
+   
+    # Fetches the object at url, and extends it with methods
+    def endpoint(url)
+      get(url).body.tap do |o|
+        o.each do |k, v|
+          o.define_singleton_method(k) do
+            ivar = :"@#{k}"
+            return instance_variable_get(ivar) if instance_variable_defined?(ivar)
+            instance_variable_set(ivar, block_given? ? yield(k, v) : v)
+          end
+        end
+      end
+    end
+
+    extend self
+  end
+end

data/lib/sfkb/settings.rb

@@ -0,0 +1,23 @@
+module SFKB
+  # Methods for getting Salesforce Knowledge settings. Mix it into something
+  # with an index.
+  module Settings
+    # Tells the default language
+    def defaultLanguage
+      settings.defaultLanguage
+    end
+
+    # The list of languages
+    def languages
+      settings.languages
+    end
+
+    def active_languages
+      settings.languages.select(&:active).map(&:name)
+    end
+
+    def settings
+      index.knowledgeManagement.settings
+    end
+  end
+end

data/test/sfkb/client_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require 'sfkb'
+
+describe SFKB::Client do
+  let(:client) { SFKB::Client.new }
+
+  it 'is a Restforce of nature' do
+    assert SFKB::Client < Restforce::Data::Client
+  end
+
+  it 'knows how to REST' do
+    assert SFKB::Client < SFKB::REST
+  end
+
+  it 'has great Knowledge' do
+    assert SFKB::Client < SFKB::Knowledge
+  end
+end

data/test/sfkb/decoration_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'sfkb/decoration'
+
+describe SFKB::Decoration do
+  include SFKB::Decoration
+
+  describe 'decorate(String)' do
+    it 'returns the string' do
+      assert_equal 'a', decorate('a')
+    end
+
+    it 'yields the string' do
+      decorate('a') do |x|
+        assert_equal 'a', x
+      end
+    end
+  end
+
+  describe 'decorate({x: y})' do
+    it 'returns the hash' do
+      assert_equal({ x: :y }, decorate(x: :y))
+    end
+  end
+
+  describe 'define_link(obj, name, url)' do
+    it 'defines a getter method for the link' do
+      foo = 'hi'
+      define_singleton_method(:get) { |x| OpenStruct.new(body: 'Found me') }
+      define_link(foo, 'bar', '/baz')
+      assert_respond_to foo, :bar
+      assert_equal "Found me", foo.bar
+    end
+  end
+
+  describe 'define_predicate(obj, name, value)' do
+    it 'defines a predicate method for value' do
+      foo = 'hi'
+      define_predicate(foo, 'bar', true)
+      define_predicate(foo, 'baz', false)
+      assert foo.bar?
+      refute foo.baz?
+    end
+  end
+
+  describe 'define_links(obj, { a: "/l1", b: "/l2" })' do
+    it 'links all urls to those names' do
+      foo = 'hi'
+      define_links(foo, { a: '/l1', b: '/l2' })
+      define_singleton_method(:get) { |x| OpenStruct.new(body: "I was at #{x}!") }
+      assert_equal 'I was at /l1!', foo.a
+      assert_equal 'I was at /l2!', foo.b
+    end
+  end
+
+  describe 'autodefine' do
+    let(:foo) { OpenStruct.new(additionalInformation: { isTall: true, isFat: false, urls: { a: '/l1' }, data: '/l3' }) }
+    it 'uses additionalInformation' do
+      define_singleton_method(:get) { |x| OpenStruct.new(body: "I was at #{x}!") }
+      autodefine(foo)
+      assert foo.isTall?
+      refute foo.isFat?
+      assert_equal 'I was at /l1!', foo.a
+      assert_equal 'I was at /l3!', foo.data
+    end
+  end
+end

data/test/sfkb/knowledge_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+require 'hipsterhash'
+require 'sfkb/knowledge'
+
+describe SFKB::Knowledge do
+  let(:subject) { klass.new }
+
+  let(:klass) do
+    Class.new(Minitest::Mock) do
+      include SFKB::Knowledge
+      define_method(:index) do
+        HipsterHash.new.tap do |hh|
+          hh[:knowledgeManagement] = {
+            articles: {
+              article: '/articles/<ArticleID>'
+            }
+          }
+        end
+      end
+    end
+  end
+
+  let(:ids) { %w(1 2 3).map { |id| Struct.new(:Id).new(id) } }
+
+  describe 'article_ids' do
+    it 'gets a list of article IDs' do
+      subject.expect(:query, ids, [/KnowledgeArticle/])
+      assert_equal %w(1 2 3), subject.article_ids
+    end
+  end
+
+  describe 'articles' do
+    it 'gets all articles based on the article_ids' do
+      subject.expect(:query, ids, [/KnowledgeArticle/])
+      subject.expect(:get, Struct.new(:body).new('a'), ['/articles/1'])
+      subject.expect(:get, Struct.new(:body).new('b'), ['/articles/2'])
+      subject.expect(:get, Struct.new(:body).new('c'), ['/articles/3'])
+      assert_equal %w(a b c), subject.articles.to_a
+    end
+  end
+
+  describe 'article' do
+    it 'gets a particular article' do
+      subject.expect(:get, Struct.new(:body).new('a'), ['/articles/1'])
+      assert_equal 'a', subject.article(1)
+    end
+  end
+end

data/test/sfkb/rest_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+require 'sfkb/rest'
+
+describe SFKB::REST do
+  let(:klass) { Class.new(Minitest::Mock) { include SFKB::REST } }
+  let(:subject) { klass.new }
+  let(:response) { |x| OpenStruct.new(body: x) }
+
+  describe 'url' do
+    it 'joins paths to params amd substitutes vars' do
+      assert_equal '/foo', subject.url('/foo')
+      assert_equal '/foo?x=1', subject.url('/foo', x: 1)
+      assert_equal '/foo?x=1&y=2', subject.url('/foo', x: 1, y: 2)
+    end
+
+    it 'substitutes vars' do
+      assert_equal '/foo/1/2', subject.url('/foo/<x>/<y>', x: 1, y: 2)
+      assert_equal '/foo/1?y=2', subject.url('/foo/<x>', x: 1, y: 2)
+      assert_equal '/foo/1?b=2&b=3&c=4',
+                    subject.url('/foo/<a>', a: 1, b: %w(2 3), c: 4)
+      assert_raises { subject.url('/foo/<blah>') }
+    end
+  end
+
+  describe 'index' do
+    let(:index) { subject.index }
+
+    before do
+      subject.expect(:options, { api_version: 'X' })
+      subject.expect(:get, OpenStruct.new(body: { a: '/a' }), ['/services/data/vX'])
+    end
+
+    it 'looks up the index for the current api version' do
+      index
+      subject.verify
+    end
+
+    it 'is a whatever was returned, hopefully a hash' do
+      assert_equal({ a: '/a' }, index)
+    end
+
+    it 'adds endpoints for the url values of the hash' do
+      subject.expect(:get, OpenStruct.new(body: { b: '/b', c: '/c' }), ['/a'])
+      assert_equal({ b: '/b', c: '/c'}, index.a)
+    end
+
+    it 'adds endpoints for the subresource' do
+      subject.expect(:get, OpenStruct.new(body: { b: '/b', c: '/c' }), ['/a'])
+      subject.expect(:get, OpenStruct.new(body: { d: '/d', e: '/e' }), ['/b'])
+      subject.expect(:get, OpenStruct.new(body: { f: '/f', g: '/g' }), ['/c'])
+      assert_equal '/d', index.a.b.d
+      assert_equal '/e', index.a.b.e
+      assert_equal '/f', index.a.c.f
+      assert_equal '/g', index.a.c.g
+    end
+  end
+end

data/test/sfkb/settings_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+require 'sfkb/settings'
+
+describe SFKB::Settings do
+  let(:subject) { klass.new }
+  let(:klass) { Class.new(Minitest::Mock) { include SFKB::Settings } }
+
+  let(:index) { Minitest::Mock.new('index') } 
+  let(:languages) { %w(zh ja en).map { |l| OpenStruct.new(name: l, active: l != 'ja') } }
+  let(:knowledgeManagement) { Minitest::Mock.new('knowledgeManagement') }
+  let(:settings) { OpenStruct.new(defaultLanguage: 'en', languages: languages) }
+    
+  before do
+    subject.expect :index, index
+    index.expect :knowledgeManagement, knowledgeManagement
+    knowledgeManagement.expect :settings, settings
+  end
+
+  it 'knows its default language' do
+    assert_equal 'en', subject.defaultLanguage
+  end
+
+  it 'knows its languages' do
+    assert_equal languages, subject.languages
+  end
+
+  it 'knows its active languages' do
+    assert_equal %w(zh en), subject.active_languages
+  end
+end

data/test/sfkb_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+require 'sfkb'
+
+describe SFKB do
+  let(:sfkb) { SFKB.new }
+
+  it 'constructs a client' do
+    assert_instance_of SFKB::Client, SFKB.new
+  end
+
+  it 'can list articles' do
+    assert_respond_to sfkb.articles, :each
+  end
+
+  describe 'an article' do
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require 'simplecov'
+SimpleCov.start
+
+require 'dotenv/load'
+
+require 'vcr'
+VCR.configure do |vcr|
+  vcr.cassette_library_dir = 'test/cassettes'
+  vcr.hook_into :faraday
+  ENV.keys.grep(/^SALESFORCE_/).each do |var|
+    vcr.filter_sensitive_data(var) { ENV[var] }
+  end
+end
+
+require 'minitest-vcr'
+MinitestVcr::Spec.configure!
+
+require 'pry'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification
+name: sfkb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JJ Buckley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: hipsterhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: |
+  A Ruby library (based on Restforce) for working with the Salesforce Knowledge
+  Base.
+email:
+- jj@bjjb.org
+executables:
+- sfkb
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/bundle
+- bin/byebug
+- bin/coderay
+- bin/console
+- bin/dotenv
+- bin/listen
+- bin/pry
+- bin/rackup
+- bin/rake
+- bin/rerun
+- bin/safe_yaml
+- bin/setup
+- bin/sfkb
+- exe/sfkb
+- lib/sfkb.rb
+- lib/sfkb/client.rb
+- lib/sfkb/decoration.rb
+- lib/sfkb/knowledge.rb
+- lib/sfkb/rest.rb
+- lib/sfkb/settings.rb
+- test/sfkb/client_test.rb
+- test/sfkb/decoration_test.rb
+- test/sfkb/knowledge_test.rb
+- test/sfkb/rest_test.rb
+- test/sfkb/settings_test.rb
+- test/sfkb_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bjjb/sfkb
+licenses:
+- MIT
+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.7.3
+signing_key: 
+specification_version: 4
+summary: SalesForce Knowledge Base helper library
+test_files: []