sfkb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74bcb08c5677a0a76c460619f7ad20114454024382d3b8ddf45aeaf3194a33c6
-  data.tar.gz: 6b2f4b46fd09d98f68a29a5be7dba289dff17e45c6d2869aabfa496016fe4885
+  metadata.gz: 70f109dc8cfd8cc42fb9de11011ef9d8686e20e8b1818221bd8621ff716b095f
+  data.tar.gz: 6c2e478a2c2a2e680dfa90bcfa225d0324cdeb324c3d0926dabf94cb27c9d05c
 SHA512:
-  metadata.gz: d5a8f43459e81bd9f0486ec67a6dbf7f846dd74571a6b6877df0d0dd4c933732df57ec493cc322ce6cd491a7c7077bab92face507b7f528e7c50ee7f10cabfbb
-  data.tar.gz: 7dd1ba208860dd203abd3c9310b1d3dca7b703e7ab58310d15fcd2a329fc659f381355f5a32ffc890a658d66d42c54c2489d1c481793971914fe51c7826918f7
+  metadata.gz: 49fefbe358e7264e0aa185843cc4c869f6676991698e7311824f7d9c42c1a0672aa091b008a5123ff67c6593d614e1f0e6954969db73bc6a0448427c33ce492b
+  data.tar.gz: 9c79a3ddfd6a7e3538baf6fe1dd9e1867de24f0767a1709b715ca50d4081b2c3349adcedb043e3d0bce3a68eed28dd4d860b7a20a5e6ba8d2c1b084ca358d789

data/README.md

@@ -5,7 +5,12 @@ 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)
+[![Build Status](http://img.shields.io/travis/bjjb/sfkb.svg?style=flat-square)](https://travis-ci.org/bjjb/sfkb)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8e717aedee6a4e956683/test_coverage)](https://codeclimate.com/github/bjjb/sfkb/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8e717aedee6a4e956683/maintainability)](https://codeclimate.com/github/bjjb/sfkb/maintainability)
+[![Dependency Status](http://img.shields.io/gemnasium/bjjb/sfkb.svg?style=flat-square)](https://gemnasium.com/bjjb/sfkb)
+[![Gem Version](http://img.shields.io/gem/v/sfkb.svg?style=flat-square)](https://rubygems.org/gems/sfkb)
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://bjjb.mit-license.org)
 
 ## Requirements
 
@@ -32,13 +37,14 @@ instantiating a `SFKB::Client`.
 For example, here's how to print the titles of the master versions of the
 first 10 documents:
 
-```
+```ruby
 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:
-```
+
+```ruby
 sf = SFKB.new
 sf.articles.select(:hasTranslations?) do |a|
     sf.translations(a, 'Draft').each do |t|

data/lib/sfkb/decoration.rb

@@ -24,16 +24,30 @@ module SFKB
     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
+      autodefine_data(object, info[:data])
+      autodefine_links(object, info[:urls])
+      autodefine_predicates(object, info)
+      object
+    end
+
+    def autodefine_predicates(object, predicates)
+      predicates.each do |k, v|
+        next unless [true, false].include?(v)
+        define_predicate(object, k, v)
       end
       object
     end
+
+    def autodefine_data(object, data)
+      return object if data.nil?
+      define_link(object, :data, data)
+      object
+    end
+
+    def autodefine_links(object, urls)
+      return if urls.nil?
+      define_links(object, urls) { |o| autodefine(o) }
+      object
+    end
   end
 end

data/lib/sfkb/rest.rb

@@ -2,7 +2,10 @@ module SFKB
   # Some REST helpers
   module REST
     # Used to interpolate variables into REST endpoint URIs
-    @@placeholder = /[<{](.+?)[>}]/
+    @@placeholder = /[<{](.+?)[>}]/.freeze
+
+    # Used to identify URLs; %s should be the api_version
+    @@url_pattern = '/services/data/v%s'.freeze
 
     # { a: :b }.inject({}, &@@stringify) #=> { 'a' => :b }
     @@stringify = lambda do |collector, kv|
@@ -27,24 +30,44 @@ module SFKB
       [path, params].reject(&:nil?).reject(&:empty?).join('?')
     end
 
+    # The starting URL
+    def services_url
+      @@url_pattern % options[:api_version]
+    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
+      endpoint(get(services_url).body)
+    end
+
+    # endpoint takes a map, and for eack key/value pair, adds a singleton
+    # method to the map which will fetch that resource (if it looks like a
+    # URL).
+    def endpoint(map)
+      map.each { |k, v| apply_endpoint(map, k, v) }
+      map
+    end
+
+    # applies an endpoint to obj, named k, which fetches v and makes it an
+    # endpoint if it looks like a URL
+    def apply_endpoint(obj, k, v)
+      α = -> { endpoint(get(v).body) }
+      β = -> { v }
+      λ = url?(v) ? -> { α.call } : -> { β.call }
+      obj.define_singleton_method(k, &λ) if url?(v)
+      obj
+    end
+
+    # Identifies a valid URL for this REST instance
+    def url?(string)
+      return false unless string.to_s =~ url_pattern
+      return false if     string.to_s =~ @@placeholder
+      true
+    end
+
+    # Identifies a valid URL for this REST instance
+    def url_pattern
+      %r{#{services_url}}
     end
 
     extend self

data/test/sfkb/rest_test.rb

@@ -2,56 +2,44 @@ require 'test_helper'
 require 'sfkb/rest'
 
 describe SFKB::REST do
-  let(:klass) { Class.new(Minitest::Mock) { include SFKB::REST } }
-  let(:subject) { klass.new }
+  include SFKB::REST
+  let(:options) { { api_version: 'X' } }
   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)
+      assert_equal '/foo', url('/foo')
+      assert_equal '/foo?x=1', url('/foo', x: 1)
+      assert_equal '/foo?x=1&y=2', 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>') }
+      assert_equal '/foo/1/2', url('/foo/<x>/<y>', x: 1, y: 2)
+      assert_equal '/foo/1?y=2', url('/foo/<x>', x: 1, y: 2)
+      assert_equal '/a/1?b=2&b=3&c=4', url('/a/<a>', a: 1, b: %w(2 3), c: 4)
+      assert_raises { url('/x/<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)
+    let(:services) { { 'a' => '/services/data/vX/a', 'b' => { foo: 123 } } }
+    let(:responses) do
+      {
+        '/services/data/vX'   => services,
+        '/services/data/vX/a' => { 'b' => '/services/data/vX/b' },
+        '/services/data/vX/b' => { 'c' => '/services/data/vX/c' },
+        '/services/data/vX/c' => OpenStruct.new('d' => 'You got me.')
+      }
     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
+    define_method(:lookup) { |url| responses.fetch(url) }
+    define_method(:get) { |url| OpenStruct.new(body: lookup(url)) }
+    it 'gets an endpoint' do
+      assert_equal services, index
+      assert_respond_to index, :a
+      assert_respond_to index.a, :b
+      assert_respond_to index.a.b, :c
+      assert_respond_to index.a.b.c, :d
+      assert_equal 'You got me.', index.a.b.c.d
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sfkb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - JJ Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: restforce
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.11'
-- !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
@@ -265,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SalesForce Knowledge Base helper library