nomis-api-client 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +8 -2
  3. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 61abe8cac6c008008682e6496d4ec8b6678d3d54
4
- data.tar.gz: 7b3f94e1036fc8be3cddb483529109de5e145e90
3
+ metadata.gz: 9f01c00cc53dffe021c027cca1743b7520afac04
4
+ data.tar.gz: 26f5e98a39244bfa62122d50fb7cfe7639712203
5
5
  SHA512:
6
- metadata.gz: f2a5063b7ad15686499cd2483c4eafb86c518f27b13613b48d535d599023c6343687277fb756736af94dbaba76e82d2b621d29adf73ad595a610ff94552926b8
7
- data.tar.gz: a04e789fb87a8f53e9ee8919d0a0d3281bf51698ff9e5c97145430e78492f76df6396a1bd6b83b1c4f4a76e89f170f0dc6de0222b04a1301b6df95ae3a698d78
6
+ metadata.gz: 794b3286287839ad68b1b9ecb332e3f366ce77614fdad4c913c6ef9aaa2d662acee92024e4b84fe3c4f6a94ce18bef046450515230443dd12ed6fe5cbdca920a
7
+ data.tar.gz: 22d4c0e3db9102a61a01e0095bd8d05558df775b63a0d1835eb64a7acb1ceaa9b524c1218f57418a0e791a42417783d982180d6da1118140ce893d7e3d3b0d75
data/README.md CHANGED
@@ -27,7 +27,7 @@ gem 'nomis-api-client'
27
27
  bundle install
28
28
  ```
29
29
 
30
- ## Usage
30
+ ## Configuration
31
31
 
32
32
  ### Authentication
33
33
 
@@ -101,6 +101,12 @@ or the environment variable NOMIS_API_BASE_URL:
101
101
  export NOMIS_API_BASE_URL='https://noms-api.service.justice.gov.uk/nomisapi/'
102
102
  ```
103
103
 
104
+ ## Loading the gem
105
+
106
+ Assuming you have the gem installed and the path in your $LOAD_PATH (this is simplest if you have bundler installed, and your bundle includes nomis-api-client), you can load the gem code with:
107
+ ```ruby
108
+ require 'nomis/api'
109
+ ```
104
110
 
105
111
  ## Making a request
106
112
 
@@ -129,7 +135,7 @@ bundle :027 > response.status
129
135
  => "200"
130
136
 
131
137
  bundle :028 > response.data
132
- => {"found"=>true, "offender"=>{"id"=>1820518}}
138
+ => {"found"=>true, "offender"=>{"id"=>1234567}}
133
139
  ```
134
140
 
135
141
  ## API Documentation
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nomis-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Al Davidson
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  version: '0'
76
76
  requirements: []
77
77
  rubyforge_project:
78
- rubygems_version: 2.5.1
78
+ rubygems_version: 2.6.12
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Minimal Ruby client for the NOMIS API