refocus 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 74f03cae9bfb4771dbf702946e7a28721687a213
4
- data.tar.gz: 1191ca2edb1b09db54f68f3766792ca52644ebb3
3
+ metadata.gz: a6ed3e20b9196f523eba596e90b964b934c75821
4
+ data.tar.gz: da43515dff536896a48386c0b0ce3253331a5cd3
5
5
  SHA512:
6
- metadata.gz: fb00a8ae1c20951017a799c78b4aa24aabfebbad4b794433573b3867ec5c89bdb97e34ff6eb51da60f325bca16b1c508c369adbdaa098107cbd14c29c2a1b795
7
- data.tar.gz: 0fa6697556d2df01b23a2b44927ed2abff941038cef24e2de7a4e8da361c4fad63194c1d4afa4dd7428f3b563fc3197b923d0cc5e19887f71f805eb0a496fe9b
6
+ metadata.gz: 2d4d1a12437f12ab40e5e5fc65a95a3ead2c525afb063693ebeac013d4e70302e2f34a869197670cb49923157d3f0eb6f13c6bac0ab9e8a3b2823f7aa47b118a
7
+ data.tar.gz: fc8fbc5ac39b097731656e94521bd704fa8a547f70dcd577727ab168df8baba37b54a4b054a19e184b91623e36d31610be5b46a9e048226171b534877f36ddb4
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- refocus (0.1.1)
4
+ refocus (0.1.2)
5
5
  clamp
6
6
  excon
7
7
 
data/README.md CHANGED
@@ -1,6 +1,9 @@
1
1
  # Refocus
2
2
 
3
- A ruby client library for [Refocus](https://github.com/salesforce/refocus).
3
+ A ruby client library and CLI for [Refocus](https://github.com/salesforce/refocus).
4
+
5
+ This client is not complete. If you notice any missing functionality, please feel free to submit a pull request!
6
+
4
7
 
5
8
  ## Installation
6
9
 
@@ -20,15 +23,37 @@ Or install it yourself as:
20
23
 
21
24
  ## Usage
22
25
 
26
+ ### CLI
27
+
28
+ Run
29
+ ```
30
+ Usage:
31
+ refocus [OPTIONS] SUBCOMMAND [ARG] ...
32
+
33
+ Parameters:
34
+ SUBCOMMAND subcommand
35
+ [ARG] ... subcommand arguments
36
+
37
+ Subcommands:
38
+ samples:get Print a sample
39
+
40
+ Options:
41
+ -h, --help print help
42
+ ```
43
+
44
+ ### Library
45
+
23
46
  Refocus will pick up `REFOCUS_HOST` and `REFOCUS_API_TOKEN` environment vars if these are set.
24
- You can create a client like this:
47
+ You can create a client like this in a `pry` or `irb` session, or in your ruby program:
25
48
 
26
49
  ```ruby
50
+ require "refocus"
51
+
27
52
  # Using env vars. This will fail if REFOCUS_HOST and REFOCUS_API_TOKEN are unset:
28
- refocs = Refocus.client
53
+ refocus = Refocus.client
29
54
 
30
55
  # Doing it yourself:
31
- refocus = Refocus.client(url: "https://my.refocus.instance.com", token: "some-token-i-generated"
56
+ refocus = Refocus.client(url: "https://my.refocus.instance.com", token: "some-token-i-generated")
32
57
  ```
33
58
  ### Subjects
34
59
 
@@ -65,8 +90,7 @@ refocus.aspects.delete(name: "my-aspect")
65
90
 
66
91
  ### Lenses
67
92
 
68
- IN PROGRESS
69
-
93
+ Lenses are not supported at this time.
70
94
 
71
95
  ## Development
72
96
 
@@ -76,4 +100,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
76
100
 
77
101
  ## Contributing
78
102
 
79
- Bug reports and pull requests are welcome on GitHub at https://github.com/sheax0r/refocus.
103
+ Bug reports and pull requests are welcome on GitHub at https://github.com/heroku/refocus-ruby
@@ -1,3 +1,3 @@
1
1
  module Refocus
2
- VERSION = "0.1.2"
2
+ VERSION = "0.1.3"
3
3
  end
data/refocus.gemspec CHANGED
@@ -16,8 +16,8 @@ Gem::Specification.new do |spec|
16
16
  spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
17
  f.match(%r{^(test|spec|features)/})
18
18
  end
19
- spec.bindir = "exe"
20
- spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.bindir = "bin"
20
+ spec.executables = ["refocus"]
21
21
  spec.require_paths = ["lib"]
22
22
 
23
23
  spec.add_development_dependency "bundler", "~> 1.16"
metadata CHANGED
@@ -1,12 +1,12 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: refocus
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Michael Shea
8
8
  autorequire:
9
- bindir: exe
9
+ bindir: bin
10
10
  cert_chain: []
11
11
  date: 2018-01-18 00:00:00.000000000 Z
12
12
  dependencies:
@@ -97,7 +97,8 @@ dependencies:
97
97
  description: Ruby client for https://github.com/salesforce/refocus
98
98
  email:
99
99
  - michael.shea@heroku.com
100
- executables: []
100
+ executables:
101
+ - refocus
101
102
  extensions: []
102
103
  extra_rdoc_files: []
103
104
  files: