omcms-ruby-client 1.0.0.pre.alpha → 1.0.1

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.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -20
  3. data/lib/omcms/version.rb +1 -1
  4. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5deece1d451527de6ac82ca314828492c15fcfa0fbb940144d86819d3a913ee7
4
- data.tar.gz: d50b85197535e0d418ff0c8daf3b750e3c0843dd488dc80123658e8a7362312a
3
+ metadata.gz: 025e673570f81cf30bbe2b7718c511705f14aad7b600dbebf745a0bb984c4842
4
+ data.tar.gz: 332d65b902775a05abd330abb400bb5eb34adb04d4348b69dc569fff34f73168
5
5
  SHA512:
6
- metadata.gz: a94d610dae99e9c644af1f572699d4db310a81a660dd39f77313d8daa1743ed1da3105ec841103fa6b80840bf96187b4cb597bb454cbabc1f920aa9830588a7b
7
- data.tar.gz: 69e4a929a5a5841dabfd50118afdcee8732615dc98db7d72169bace4d3d6583066b67df9b444e270c0b04fba5a95a88dbd5cd894afb46df8a18ba3925563609f
6
+ metadata.gz: 211e3ba0b41dc803cd86ccec1e6e3f95d2c5bbeb102ef97159ee7e51cc70b502a4687ee1c3ece6c51fbe807dc369919aab6e1a841cbf8b467ad6dad4a8b0b86f
7
+ data.tar.gz: c13b67cd42c4c1fc89a6e732c3298c44b1c2ee25b147ed98dfe062cc7eda2e4066d5f7222745beb9e65913142a8ea49a2f378ddd44fa71312f2bbfd5b94b68ee
data/README.md CHANGED
@@ -12,11 +12,15 @@ gem 'omcms-ruby-client'
12
12
 
13
13
  And then execute:
14
14
 
15
- $ bundle
15
+ ```shell
16
+ $ bundle
17
+ ```
16
18
 
17
19
  Or install it yourself as:
18
20
 
19
- $ gem install omcms-ruby-client
21
+ ```shell
22
+ $ gem install omcms-ruby-client
23
+ ```
20
24
 
21
25
  ## Usage
22
26
 
@@ -26,7 +30,7 @@ Create a client using your OMCMS connector's public key and private key
26
30
  # config/initializers/omcms.rb
27
31
 
28
32
  $omcms = OMCMS::Client.new(
29
- host: ENV["OMCMS_API_HOST"], # http://localhost:8877
33
+ host: ENV["OMCMS_API_HOST"], # https://www.example.com
30
34
  public_key: ENV["OMCMS_PUBLIC_KEY"],
31
35
  private_key: ENV["OMCMS_PRIVATE_KEY"]
32
36
  )
@@ -40,8 +44,8 @@ You can fetch all or specific offering with `OMCMS::Client`
40
44
  offerings = $omcms.offerings.all
41
45
  # => fetch all offerings available on OMCMS
42
46
 
43
- offering = $omcms.offerings.get(123)
44
- # => offering(id = 123) fetched from OMCMS
47
+ offering = $omcms.offerings.get(1)
48
+ # => offering(id = 1) fetched from OMCMS
45
49
  ```
46
50
 
47
51
  ### Component
@@ -49,13 +53,13 @@ offering = $omcms.offerings.get(123)
49
53
  You can fetch all or specific component with specified `offering`
50
54
 
51
55
  ```ruby
52
- offering = $omcms.offerings.get(123)
56
+ offering = $omcms.offerings.get(1)
53
57
 
54
58
  components = offering.components.all
55
- # => all components of offering(id = 123)
59
+ # => all components of offering(id = 1)
56
60
 
57
- component = offering.components.get(456)
58
- # => component(id = 456) of offering(id = 123)
61
+ component = offering.components.get(4)
62
+ # => component(id = 4) of offering(id = 1)
59
63
  ```
60
64
 
61
65
  ### Offering Data
@@ -63,21 +67,15 @@ component = offering.components.get(456)
63
67
  You can fetch all or specific offering_data with specified `offering`
64
68
 
65
69
  ```ruby
66
- offering = $omcms.offerings.get(123)
70
+ offering = $omcms.offerings.get(1)
67
71
 
68
72
  offering_data = offering.data.all
69
- # => all offering_data of offering(id = 123)
73
+ # => all offering_data of offering(id = 1)
70
74
 
71
- offering_data = offering.data.get(456)
72
- # => offering_data(id: 456) of offering(id = 123)
75
+ offering_data = offering.data.get(1)
76
+ # => offering_data(id: 1) of offering(id = 1)
73
77
  ```
74
78
 
75
- ## Development
76
-
77
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
78
-
79
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
80
-
81
79
  ## Contributing
82
80
 
83
- Bug reports and pull requests are welcome on GitHub at https://github.com/equitymultiple/omcms-ruby-client.
81
+ Bug reports and pull requests are welcome on GitHub at <https://github.com/equitymultiple/omcms-ruby-client.>
data/lib/omcms/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module OMCMS
2
- VERSION = "1.0.0-alpha"
2
+ VERSION = "1.0.1"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: omcms-ruby-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.pre.alpha
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Pradeep Rawat
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2019-11-07 00:00:00.000000000 Z
11
+ date: 2019-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -127,9 +127,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
127
127
  version: '0'
128
128
  required_rubygems_version: !ruby/object:Gem::Requirement
129
129
  requirements:
130
- - - ">"
130
+ - - ">="
131
131
  - !ruby/object:Gem::Version
132
- version: 1.3.1
132
+ version: '0'
133
133
  requirements: []
134
134
  rubygems_version: 3.0.6
135
135
  signing_key: