splitapi-rb 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a1eb207ee1935989e0fe0c5d4577922667a5c98
-  data.tar.gz: 3a36139c534cedff98a4953872172d4f0470188b
+  metadata.gz: 9c47e3c424787193e33b8e2c0a9136f14ae3a948
+  data.tar.gz: e8246c77acd22d24cf5068dcfa6f8e0c8e193eb7
 SHA512:
-  metadata.gz: bd68391a7c70338900949f4f3e54f2f85509948b129c1c7dc15db7a09ee71c5acb44c73b99e600a7f82e78c46c14fb21d208849ae9019b5091a47931519cceb6
-  data.tar.gz: fe8e6f39a25c6e63f284b1eeadd2ebe7e15f0c3c9e931dcf58b3537154e547b9e9e6f83e1d2d704cff013c315bfb10e8bae8546ba719890baa850f9c36d199c2
+  metadata.gz: 90890cef468d26fffec054497d5b0a36773c199581cc171f86699edb647f3673276224038c15d7064c28398db29921a498181b6fb563f24586320ceb3c882d42
+  data.tar.gz: 15d89da26203e89d1c842c36dda9b6f4cd677158dc9b23cc02aed9ce53830f250b6b41dd108281012be2aefa6f87c79018f03ba0b0e35d9f63d3e0c84dc6bb01

data/CHANGES

@@ -0,0 +1,7 @@
+1.0.1
+
+Use camel case instead of snake case in JSON response.
+
+1.0.0
+
+Initial release

data/DetailedReadme.md

@@ -0,0 +1,216 @@
+# Identify API Ruby
+
+This gem provides simple API to make requests to the Split's Identify API.
+
+## Installation
+
+Add this gem to your Gemfile as usual:
+
+```ruby
+gem 'splitapi-rb'
+```
+
+## Usage
+
+**Initialize client**
+
+```ruby
+client = SplitApi::Client.new(api_key: 'SPLIT_ADMIN_TOKEN', base_uri: 'SPLIT_IDENTIFY_BASE_URI')
+```
+
+**Make requests**
+
+Now we have following models `Attributes`, `Environments`, `Identities`, `TrafficTypes`.
+
+### Attributes
+
+Available methods:
+
+**list**: fetch all known attributes for traffic type
+
+_arguments_: `traffic_type_id`
+
+```ruby
+client.attributes.list('traffic_type_id')
+# example response:
+[
+  {
+    "id" => "string",
+    "traffic_type_id" => "string",
+    "display_name" => "string",
+    "description" => "string",
+    "dataType" => "string"
+  },
+  # ...
+]
+```
+
+**save**: create new attribute for traffic type
+
+_arguments_: `attribute_hash`
+
+```ruby
+client.attributes.save(
+  id: "string",
+  traffic_type_id: "string",
+  display_name: "string",
+  description: "string",
+  data_type: "string"
+)
+# example response:
+{
+  "id" => "string",
+  "organization_id" => "string",
+  "traffic_type_id" => "string",
+  "display_name" => "string",
+  "description" => "string",
+  "data_type" => "string"
+}
+```
+
+**delete**: delete attribute by key
+
+_arguments_: `traffic_type_id`, `attribute_id`
+
+```ruby
+client.attributes.delete('traffic_type_id', 'attribute_id')
+# example response:
+true
+```
+
+### Environments
+
+Available methods:
+
+**list**: fetch environments
+
+_arguments_: none
+
+```ruby
+client.environments.list
+# example response
+[
+  {
+    "id" => "string",
+    "name" => "string"
+  },
+  # ...
+]
+```
+
+### Identities
+
+Available methods:
+
+**save**: add identity
+
+_arguments_: `identity_hash`
+
+```ruby
+client.identities.save(
+  traffic_type_id: "string",
+  environment_id: "string",
+  key: "string",
+  values: {
+    key: "value"
+  }
+)
+# example response:
+{
+  "traffic_type_id" => "string",
+  "environment_id" => "string",
+  "key" => "string",
+  "values" => {
+    "key" => "value"
+  }
+}
+```
+
+**update**: update identity
+
+_arguments_: `identity_hash`
+
+```ruby
+client.identities.update(
+  traffic_type_id: "string",
+  environment_id: "string",
+  key: "string",
+  values: {
+    key: "value"
+  }
+)
+# example response:
+{
+  "traffic_type_id" => "string",
+  "environment_id" => "string",
+  "key" => "string",
+  "values" => {
+    "key" => "value"
+  }
+}
+```
+
+**save_all**: save multiple identities
+
+_arguments_: `traffic_type_id`, `environment_id`, `identity_array`
+
+```ruby
+client.identities.save_all("string", "string",
+  [
+    {
+      "traffic_type_id" => "string",
+      "environment_id" => "string",
+      "key" => "string",
+      "values" => {
+        "foo" => "bar"
+      }
+    },
+    # ...
+  ]
+)
+# example response:
+{
+  [
+    {
+      "values" => { "foo" => "bar" },
+      "key" => "string",
+      "environment_id" => "string",
+      "traffic_type_id" => "string",
+      "organization_id" => "string",
+      "timestamp" => "integer"
+    },
+    # ...
+  ]
+}
+```
+
+**delete**: delete all attributes of a specific key
+
+_arguments_: `traffic_type_id`, `environment_id`, `key`
+
+```ruby
+client.identities.delete(`traffic_type_id`, `environment_id`, `key`)
+# example response:
+true
+```
+
+### Traffic Types
+
+Available methods:
+
+**list**: list traffic types
+
+_arguments_: none
+
+```ruby
+client.traffic_types.list
+# example response:
+[
+  {
+    "id": "string",
+    "name": "string",
+    "display_attribute_id": "string"
+  },
+  # ...
+]
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    splitapi-rb (1.0.0)
+    splitapi-rb (1.0.1)
       json (~> 1.8)
       rest-client (~> 2.0)
 

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2016 Split Software, Co.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,216 +1,38 @@
-# Identify API Ruby
+# Split Ruby API
 
-This gem provides simple API to make requests to the Split's Identify API.
+This API wrapper is designed to work with [Split](https://www.split.io), the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
 
-## Installation
+### Quick setup
 
-Add this gem to your Gemfile as usual:
+For specific instructions on how to use this API refer to our [Detailed Readme](DetailedReadme.md) or our [official API documentation](https://docs.split.io/reference).
 
-```ruby
-gem 'splitapi-rb'
-```
+### Commitment to Quality:
 
-## Usage
+Split’s APIs are in active development and are constantly tested for quality. Unit tests are developed for each wrapper based on the unique needs of that language, and integration tests, load and performance tests, and behavior consistency tests are running 24/7 via automated bots. In addition, monitoring instrumentation ensures that these wrappers behave under the expected parameters of memory, CPU, and I/O.
 
-**Initialize client**
+### About Split:
 
-```ruby
-client = SplitApi::Client.new(api_key: 'SPLIT_ADMIN_TOKEN', base_uri: 'SPLIT_IDENTIFY_BASE_URI')
-```
+Split is the leading platform for intelligent software delivery, helping businesses of all sizes deliver exceptional user experiences, and mitigate risk, by providing an easy, secure way to target features to customers. Companies like WePay, LendingTree and thredUP rely on Split to safely launch and test new features and derive insights on their use. Founded in 2015, Split's team comes from some of the most innovative enterprises in Silicon Valley, including Google, LinkedIn, Salesforce and Splunk. Split is based in Redwood City, California and backed by Accel Partners and Lightspeed Venture Partners. To learn more about Split, contact hello@split.io, or start a 14-day free trial at www.split.io/trial.
 
-**Make requests**
+Split has built and maintains a API wrappers for:
 
-Now we have following models `Attributes`, `Environments`, `Identities`, `TrafficTypes`.
-
-### Attributes
-
-Available methods:
-
-**list**: fetch all known attributes for traffic type
+* Java [Github](https://github.com/splitio/java-api)
+* Node [Github](https://github.com/splitio/javascript-api)
+* .NET [Github](https://github.com/splitio/net-api)
+* Ruby [Github](https://github.com/splitio/ruby-api)
+* PHP [Github](https://github.com/splitio/php-api)
+* Python [Github](https://github.com/splitio/python-api)
 
-_arguments_: `traffic_type_id`
+For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 
-```ruby
-client.attributes.list('traffic_type_id')
-# example response:
-[
-  {
-    "id" => "string",
-    "traffic_type_id" => "string",
-    "display_name" => "string",
-    "description" => "string",
-    "dataType" => "string"
-  },
-  # ...
-]
-```
-
-**save**: create new attribute for traffic type
-
-_arguments_: `attribute_hash`
-
-```ruby
-client.attributes.save(
-  id: "string",
-  traffic_type_id: "string",
-  display_name: "string",
-  description: "string",
-  data_type: "string"
-)
-# example response:
-{
-  "id" => "string",
-  "organization_id" => "string",
-  "traffic_type_id" => "string",
-  "display_name" => "string",
-  "description" => "string",
-  "data_type" => "string"
-}
-```
-
-**delete**: delete attribute by key
-
-_arguments_: `traffic_type_id`, `attribute_id`
-
-```ruby
-client.attributes.delete('traffic_type_id', 'attribute_id')
-# example response:
-true
-```
-
-### Environments
-
-Available methods:
-
-**list**: fetch environments
-
-_arguments_: none
-
-```ruby
-client.environments.list
-# example response
-[
-  {
-    "id" => "string",
-    "name" => "string"
-  },
-  # ...
-]
-```
-
-### Identities
-
-Available methods:
-
-**save**: add identity
-
-_arguments_: `identity_hash`
-
-```ruby
-client.identities.save(
-  traffic_type_id: "string",
-  environment_id: "string",
-  key: "string",
-  values: {
-    key: "value"
-  }
-)
-# example response:
-{
-  "traffic_type_id" => "string",
-  "environment_id" => "string",
-  "key" => "string",
-  "values" => {
-    "key" => "value"
-  }
-}
-```
-
-**update**: update identity
-
-_arguments_: `identity_hash`
-
-```ruby
-client.identities.update(
-  traffic_type_id: "string",
-  environment_id: "string",
-  key: "string",
-  values: {
-    key: "value"
-  }
-)
-# example response:
-{
-  "traffic_type_id" => "string",
-  "environment_id" => "string",
-  "key" => "string",
-  "values" => {
-    "key" => "value"
-  }
-}
-```
-
-**save_all**: save multiple identities
-
-_arguments_: `traffic_type_id`, `environment_id`, `identity_array`
-
-```ruby
-client.identities.save_all("string", "string",
-  [
-    {
-      "traffic_type_id" => "string",
-      "environment_id" => "string",
-      "key" => "string",
-      "values" => {
-        "foo" => "bar"
-      }
-    },
-    # ...
-  ]
-)
-# example response:
-{
-  [
-    {
-      "values" => { "foo" => "bar" },
-      "key" => "string",
-      "environment_id" => "string",
-      "traffic_type_id" => "string",
-      "organization_id" => "string",
-      "timestamp" => "integer"
-    },
-    # ...
-  ]
-}
-```
-
-**delete**: delete all attributes of a specific key
-
-_arguments_: `traffic_type_id`, `environment_id`, `key`
-
-```ruby
-client.identities.delete(`traffic_type_id`, `environment_id`, `key`)
-# example response:
-true
-```
-
-### Traffic Types
-
-Available methods:
-
-**list**: list traffic types
-
-_arguments_: none
-
-```ruby
-client.traffic_types.list
-# example response:
-[
-  {
-    "id": "string",
-    "name": "string",
-    "display_attribute_id": "string"
-  },
-  # ...
-]
-```
+**Try Split for Free:**
+
+Split is available as a 14-day free trial. To create an account, visit [split.io/trial](https://www.split.io/trial).
+
+**Learn more about Split:** 
+
+Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [docs.split.io](http://docs.split.io) for more detailed information.
+
+**System Status:**
+
+We use a status page to monitor the availability of Split’s various services. You can check the current status at [status.split.io](http://status.split.io).

data/lib/splitapi-rb/models/attributes.rb

@@ -14,9 +14,7 @@ module SplitApi
           RestClient.get(
             "#{@config.base_uri}/trafficTypes/#{traffic_type_id}/schema", auth_headers
           ).body
-        ).map do |identity|
-          identity.map { |k, v| [to_underscore(k), v] }.to_h
-        end
+        )
       end
 
       # PUT /trafficTypes/{traffic_type_id}/schema
@@ -31,7 +29,7 @@ module SplitApi
               'description' => attribute[:description],
               'dataType' => attribute[:data_type]
             }.to_json, auth_headers).body
-        ).map { |k, v| [to_underscore(k), v] }.to_h
+        )
       end
 
       # DELETE /trafficTypes/{traffic_type_id}/schema/{attribute_id}

data/lib/splitapi-rb/models/environments.rb

@@ -10,9 +10,7 @@ module SplitApi
 
       # GET /environments
       def list
-        JSON.parse(RestClient.get("#{@config.base_uri}/environments", auth_headers).body).map do |identity|
-          identity.map { |k, v| [to_underscore(k), v] }.to_h
-        end
+        JSON.parse(RestClient.get("#{@config.base_uri}/environments", auth_headers).body)
       end
     end
   end

data/lib/splitapi-rb/models/identities.rb

@@ -18,7 +18,7 @@ module SplitApi
             'trafficTypeId' => identity[:traffic_type_id],
             'environmentId' => identity[:environment_id],
             'values' => identity[:values]
-          }.to_json, auth_headers).body).map { |k, v| [to_underscore(k), v] }.to_h
+          }.to_json, auth_headers).body)
       end
 
       # POST /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities
@@ -28,9 +28,7 @@ module SplitApi
           "/environments/#{environment_id}" \
           "/identities",
           identities.to_json, auth_headers).body
-        )['objects'].map do |identity|
-          identity.map { |k, v| [to_underscore(k), v] }.to_h
-        end
+        )['objects']
       end
 
       # PATCH /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}
@@ -43,7 +41,7 @@ module SplitApi
             'trafficTypeId' => identity[:traffic_type_id],
             'environmentId' => identity[:environment_id],
             'values' => identity[:values]
-          }.to_json, auth_headers).body).map { |k, v| [to_underscore(k), v] }.to_h
+          }.to_json, auth_headers).body)
       end
 
       # DELETE /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}

data/lib/splitapi-rb/models/traffic_types.rb

@@ -10,9 +10,7 @@ module SplitApi
 
       # GET /trafficTypes
       def list
-        JSON.parse(RestClient.get("#{@config.base_uri}/trafficTypes", auth_headers).body).map do |identity|
-          identity.map { |k, v| [to_underscore(k), v] }.to_h
-        end
+        JSON.parse(RestClient.get("#{@config.base_uri}/trafficTypes", auth_headers).body)
       end
     end
   end

data/lib/splitapi-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitApi
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitapi-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,8 +145,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGES
+- DetailedReadme.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - NEWS
 - README.md
 - lib/splitapi-rb.rb