Module: HeedKit

Defined in:
lib/heedkit.rb,
lib/heedkit/client.rb,
lib/heedkit/railtie.rb,
lib/heedkit/roadmap.rb,
lib/heedkit/version.rb,
lib/heedkit/changelog.rb

Overview

Ruby / Rails SDK for HeedKit — fetch a project's public roadmap and drive the end-user feedback API (identify / list / submit / vote / comment) from your server.

HeedKit.configure do |c|
c.project_key = "fk_..."
c.endpoint    = "https://acme.heedkit.com"   # your HeedKit base URL
end

HeedKit.roadmap            # => HeedKit::Roadmap
HeedKit.client.identify(external_id: "u-1")

Defined Under Namespace

Modules: Helper Classes: Changelog, ChangelogEntry, Client, Configuration, Error, Railtie, Roadmap, RoadmapItem

Constant Summary collapse

VERSION = 
"0.2.0"

Class Method Summary collapse

Class Method Details

.changelog ⇒ Object 



52
53
54
 
# File 'lib/heedkit.rb', line 52

def changelog
  client.changelog
end

.client ⇒ Object

A client built from the global configuration.



43
44
45
46
 
# File 'lib/heedkit.rb', line 43

def client
  Client.new(project_key: configuration.project_key, endpoint: configuration.endpoint,
             secret_key: configuration.secret_key, timeout: configuration.timeout)
end

.configuration ⇒ Object 



34
35
36
 
# File 'lib/heedkit.rb', line 34

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



38
39
40
 
# File 'lib/heedkit.rb', line 38

def configure
  yield configuration
end

.roadmap ⇒ Object 



48
49
50
 
# File 'lib/heedkit.rb', line 48

def roadmap
  client.roadmap
end