identity_crm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b5daf2f03bf62901623fa17baf56618e8c81751
-  data.tar.gz: 1728ffdd8e604689f2fa7de47d8a70ea2ff5ceed
+  metadata.gz: aef4f14514fbacb7185dda93be21ccbd7b4cd5ca
+  data.tar.gz: 487ee335ae2010a9cbd4d2c7855c22b2104b6a2a
 SHA512:
-  metadata.gz: 36ba32b60a7f91e4b05866f161419444ab4ca942d28720419c2e6989ab0f3ba0ae5b8349a98878f8b942d8a5cd218a84f89983f6a9a9bb03495f24e30eb29a42
-  data.tar.gz: 89384ff2e6611acf6cc6b61c91e9ae535b8232d46ee1f56d1ce0a7f58562fd25f834793b5a07868c05ebf1dfc4d399b7b6555b6c5a4e5bc285ef05e5d396c636
+  metadata.gz: a8e53a51bd681a943c017044690ffb69c363e085894ebb0773556856311bc43b4c98ec245e6db0a35d416a4790a0f8532598386bc24d1b01549954859dc8d866
+  data.tar.gz: 6d3d6ff96eb08d7ae5d39f487ebfb0cde864dd7d7016cad18ef3f44b9b7844c73d669359345ab23e8b4a8157541815f8d973628a00f47d8345b7f7df8c01db28

data/README.md

@@ -0,0 +1,84 @@
+# Ruby Client for the Identity API
+
+A Ruby client for the Identity >= v2 API.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'identity_crm'
+```
+
+And then load it into your application:
+
+```ruby
+require 'identity_crm'
+```
+
+### Initialising the client
+
+The client is initialised with a user, a token and the url of the Identity server.
+
+```rb
+@client = IdentityCRM::Client.new(
+  user: ENV["IDENTITY_API_USER"],
+  token: ENV["IDENTITY_API_TOKEN"],
+  url: 'http://localhost:5000'
+)
+```
+
+### GET requests
+
+You can get details about one or many resources in the API by calling the
+`#get` method.
+
+#### Getting a single resource
+
+To request a single resource, use the `#get` method:
+
+```rb
+@client.members.get(member_id)
+```
+
+A call to `get` returns an instance of the resource:
+
+```rb
+@client.members.get(member_id).first_name
+```
+
+Some resources can also be requested with alternative parameters
+
+```rb
+@client.members.get(params: { guid: 'abc123' })
+```
+
+```rb
+@client.members.get(params: { email: 'test@example.com' })
+```
+
+### POST requests
+
+Resources are created in the API by calling the `#create` method with the body passed through `params` key.
+
+#### Creating a single resource
+
+```rb
+@client.members.create(params: {
+  email: 'test@example.com',
+  first_name: 'Yoelo',
+  last_name: 'Svenslol',
+})
+```
+
+
+### Request options
+
+The `options` hash can be passed with options for the request. Currently supported settings are: `timeout`.
+
+```rb
+@client.members.get(
+  params: { guid: 'abc123' },
+  options: { timeout: 0.5 }
+)
+```

data/lib/identity_crm/version.rb

@@ -1,3 +1,3 @@
 module IdentityCRM
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: identity_crm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joel E. Svensson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -52,6 +52,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - identity_crm.gemspec
 - lib/identity_crm.rb
 - lib/identity_crm/client.rb