splitapi-rb 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c47e3c424787193e33b8e2c0a9136f14ae3a948
-  data.tar.gz: e8246c77acd22d24cf5068dcfa6f8e0c8e193eb7
+  metadata.gz: eec601d03cbbf685c204ea7ebe8425fea35b90ec
+  data.tar.gz: b76629bf58ed478931126350d0b23c3c7082fa32
 SHA512:
-  metadata.gz: 90890cef468d26fffec054497d5b0a36773c199581cc171f86699edb647f3673276224038c15d7064c28398db29921a498181b6fb563f24586320ceb3c882d42
-  data.tar.gz: 15d89da26203e89d1c842c36dda9b6f4cd677158dc9b23cc02aed9ce53830f250b6b41dd108281012be2aefa6f87c79018f03ba0b0e35d9f63d3e0c84dc6bb01
+  metadata.gz: d467adfe57c0e1698f5fb788299c4457384d20c9ce040b71f70233de716b01b290494b1a464cfb7c1b4979164626cc6fe688ba388647ceea26917a8b122b802b
+  data.tar.gz: 9b2ee377a328b1dc70611af52094ee402c46e116dfd535344f3c81ed169d54d8d607fb7ec4cca8e0c3009a908599e090f5f9ca7996f3e0028811667b3deb0f5b

data/CHANGES

@@ -1,3 +1,19 @@
+1.2.0
+
+Add default uri
+
+1.1.1
+
+Fix specs from being false positive, add to_h method
+
+1.1.0
+
+Return DTOs instead of hashes
+
+1.0.2
+
+Return "failed" and "metadata" alongside with "objects" when calling Identities#save_all
+
 1.0.1
 
 Use camel case instead of snake case in JSON response.

data/DetailedReadme.md

@@ -22,7 +22,58 @@ client = SplitApi::Client.new(api_key: 'SPLIT_ADMIN_TOKEN', base_uri: 'SPLIT_IDE
 
 Now we have following models `Attributes`, `Environments`, `Identities`, `TrafficTypes`.
 
-### Attributes
+### Data Objects
+
+Models can return the following:
+
+- true/false (when `#delete` method was called)
+- `SplitApi::DataObjects::Attribute`, `SplitApi::DataObjects::Environment`, `SplitApi::DataObjects::Identify` or `SplitApi::DataObjects::DataType`
+- array of the above DTOs (when `#save_all` or `#list` was called)
+
+Data objects structure:
+
+#### Attribute DTO
+```
+#<SplitApi::DataObjects::Attribute
+  @description="string",
+  @display_name="string",
+  @id="string",
+  @is_searchable="true/false",
+  @organization_id="string",
+  @traffic_type_id="string"
+>
+```
+
+#### Environment DTOs
+```
+#<SplitApi::DataObjects::Environment
+  @name="string",
+  @id="string",
+>
+```
+
+#### Identity DTO
+```
+#<SplitApi::DataObjects::Identity
+  @values="string",
+  @key="string",
+  @environment_id="string",
+  @organization_id="string",
+  @traffic_type_id="string",
+  @timestamp="number"
+>
+```
+
+#### TrafficType DTO
+```
+#<SplitApi::DataObjects::TrafficType
+  @name="string",
+  @id="string",
+  @display_attribute_id="string"
+>
+```
+
+### Attributes model
 
 Available methods:
 
@@ -34,13 +85,7 @@ _arguments_: `traffic_type_id`
 client.attributes.list('traffic_type_id')
 # example response:
 [
-  {
-    "id" => "string",
-    "traffic_type_id" => "string",
-    "display_name" => "string",
-    "description" => "string",
-    "dataType" => "string"
-  },
+  SplitApi::DataObjects::Attribute,
   # ...
 ]
 ```
@@ -58,14 +103,7 @@ client.attributes.save(
   data_type: "string"
 )
 # example response:
-{
-  "id" => "string",
-  "organization_id" => "string",
-  "traffic_type_id" => "string",
-  "display_name" => "string",
-  "description" => "string",
-  "data_type" => "string"
-}
+SplitApi::DataObjects::Attribute
 ```
 
 **delete**: delete attribute by key
@@ -78,7 +116,7 @@ client.attributes.delete('traffic_type_id', 'attribute_id')
 true
 ```
 
-### Environments
+### Environments model
 
 Available methods:
 
@@ -90,15 +128,12 @@ _arguments_: none
 client.environments.list
 # example response
 [
-  {
-    "id" => "string",
-    "name" => "string"
-  },
+  SplitApi::DataObjects::Environment,
   # ...
 ]
 ```
 
-### Identities
+### Identities model
 
 Available methods:
 
@@ -116,14 +151,7 @@ client.identities.save(
   }
 )
 # example response:
-{
-  "traffic_type_id" => "string",
-  "environment_id" => "string",
-  "key" => "string",
-  "values" => {
-    "key" => "value"
-  }
-}
+SplitApi::DataObjects::Identity
 ```
 
 **update**: update identity
@@ -140,14 +168,7 @@ client.identities.update(
   }
 )
 # example response:
-{
-  "traffic_type_id" => "string",
-  "environment_id" => "string",
-  "key" => "string",
-  "values" => {
-    "key" => "value"
-  }
-}
+SplitApi::DataObjects::Identity
 ```
 
 **save_all**: save multiple identities
@@ -171,16 +192,11 @@ client.identities.save_all("string", "string",
 # example response:
 {
   [
-    {
-      "values" => { "foo" => "bar" },
-      "key" => "string",
-      "environment_id" => "string",
-      "traffic_type_id" => "string",
-      "organization_id" => "string",
-      "timestamp" => "integer"
-    },
+    SplitApi::DataObjects::Identity,
     # ...
-  ]
+  ],
+  "failed": [],
+  "metadata": {}
 }
 ```
 
@@ -194,7 +210,7 @@ client.identities.delete(`traffic_type_id`, `environment_id`, `key`)
 true
 ```
 
-### Traffic Types
+### Traffic Types model
 
 Available methods:
 
@@ -206,11 +222,7 @@ _arguments_: none
 client.traffic_types.list
 # example response:
 [
-  {
-    "id": "string",
-    "name": "string",
-    "display_attribute_id": "string"
-  },
+  SplitApi::DataObjects::TrafficType
   # ...
 ]
 ```

data/Gemfile.lock

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

data/NEWS

@@ -1,3 +1,7 @@
+1.1.0
+
+Models now return DTOs instaed of plain hashes
+
 1.0.0
 
 Initial release

data/README.md

@@ -18,7 +18,7 @@ Split has built and maintains a API wrappers for:
 
 * Java [Github](https://github.com/splitio/java-api)
 * Node [Github](https://github.com/splitio/javascript-api)
-* .NET [Github](https://github.com/splitio/net-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)

data/lib/splitapi-rb.rb

@@ -5,6 +5,12 @@ require 'splitapi-rb/version'
 require 'splitapi-rb/client'
 require 'splitapi-rb/config'
 
+require 'splitapi-rb/data_objects/base_data_object'
+require 'splitapi-rb/data_objects/attribute'
+require 'splitapi-rb/data_objects/environment'
+require 'splitapi-rb/data_objects/identity'
+require 'splitapi-rb/data_objects/traffic_type'
+
 require 'splitapi-rb/models/base_model'
 require 'splitapi-rb/models/attributes'
 require 'splitapi-rb/models/environments'

data/lib/splitapi-rb/config.rb

@@ -1,12 +1,14 @@
 module SplitApi
   class Config
+    DEFAULT_URI = 'https://api.split.io/internal/api/v1'.freeze
+
     # Base URI for the API
     attr_reader :base_uri
     # API key to authorize API requests
     attr_reader :api_key
 
     def initialize(opts)
-      @base_uri = opts[:base_uri]
+      @base_uri = (opts[:base_uri] || DEFAULT_URI).chomp('/')
       @api_key = opts[:api_key]
     end
   end

data/lib/splitapi-rb/data_objects/attribute.rb

@@ -0,0 +1,8 @@
+module SplitApi
+  module DataObjects
+    class Attribute < BaseDataObject
+      PROPERTIES = %i(description display_name traffic_type_id id organization_id data_type is_searchable).freeze
+      attr_accessor *PROPERTIES
+    end
+  end
+end

data/lib/splitapi-rb/data_objects/base_data_object.rb

@@ -0,0 +1,23 @@
+module SplitApi
+  module DataObjects
+    class BaseDataObject
+      PROPERTIES = %i().freeze # this is redefined in the subclass
+
+      def initialize(opts = {})
+        opts.each do |k, v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+
+      def ==(other_obj)
+        self.class::PROPERTIES.all? { |property| send(property) == other_obj.send(property) }
+      end
+
+      def to_h
+        self.class::PROPERTIES.each_with_object({}) do |property, memo|
+          memo.merge!(property => instance_variable_get("@#{property}"))
+        end
+      end
+    end
+  end
+end

data/lib/splitapi-rb/data_objects/environment.rb

@@ -0,0 +1,8 @@
+module SplitApi
+  module DataObjects
+    class Environment < BaseDataObject
+      PROPERTIES = %i(id name).freeze
+      attr_accessor *PROPERTIES
+    end
+  end
+end

data/lib/splitapi-rb/data_objects/identity.rb

@@ -0,0 +1,8 @@
+module SplitApi
+  module DataObjects
+    class Identity < BaseDataObject
+      PROPERTIES = %i(values key environment_id traffic_type_id organization_id timestamp).freeze
+      attr_accessor *PROPERTIES
+    end
+  end
+end

data/lib/splitapi-rb/data_objects/traffic_type.rb

@@ -0,0 +1,8 @@
+module SplitApi
+  module DataObjects
+    class TrafficType < BaseDataObject
+      PROPERTIES = %i(id display_attribute_id name).freeze
+      attr_accessor *PROPERTIES
+    end
+  end
+end

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

@@ -14,12 +14,22 @@ module SplitApi
           RestClient.get(
             "#{@config.base_uri}/trafficTypes/#{traffic_type_id}/schema", auth_headers
           ).body
-        )
+        ).map do |attribute|
+          DataObjects::Attribute.new(
+            description: attribute['description'],
+            display_name: attribute['displayName'],
+            traffic_type_id: attribute['trafficTypeId'],
+            id: attribute['id'],
+            organization_id: attribute['organizationId'],
+            data_type: attribute['dataType'],
+            is_searchable: attribute['isSearchable']
+          )
+        end
       end
 
       # PUT /trafficTypes/{traffic_type_id}/schema
       def save(attribute)
-        JSON.parse(
+        attribute = JSON.parse(
           RestClient.put(
             "#{@config.base_uri}/trafficTypes/#{attribute[:traffic_type_id]}/schema",
             {
@@ -28,7 +38,18 @@ module SplitApi
               'displayName' => attribute[:display_name],
               'description' => attribute[:description],
               'dataType' => attribute[:data_type]
-            }.to_json, auth_headers).body
+            }.to_json, auth_headers
+          ).body
+        )
+
+        DataObjects::Attribute.new(
+          description: attribute['description'],
+          display_name: attribute['displayName'],
+          traffic_type_id: attribute['trafficTypeId'],
+          id: attribute['id'],
+          organization_id: attribute['organizationId'],
+          data_type: attribute['dataType'],
+          is_searchable: attribute['isSearchable']
         )
       end
 

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

@@ -10,7 +10,12 @@ module SplitApi
 
       # GET /environments
       def list
-        JSON.parse(RestClient.get("#{@config.base_uri}/environments", auth_headers).body)
+        JSON.parse(RestClient.get("#{@config.base_uri}/environments", auth_headers).body).map do |environment|
+          DataObjects::Environment.new(
+            id: environment['id'],
+            name: environment['name']
+          )
+        end
       end
     end
   end

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

@@ -10,38 +10,72 @@ module SplitApi
 
       # PUT /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}
       def save(identity)
-        JSON.parse(RestClient.put(
+        identity = JSON.parse(RestClient.put(
           "#{@config.base_uri}/trafficTypes/#{identity[:traffic_type_id]}" \
           "/environments/#{identity[:environment_id]}/identities/#{identity[:key]}",
           {
             'key' => identity[:key],
             'trafficTypeId' => identity[:traffic_type_id],
             'environmentId' => identity[:environment_id],
+            'organizationId' => identity[:organization_id],
             'values' => identity[:values]
           }.to_json, auth_headers).body)
+
+        DataObjects::Identity.new(
+          key: identity['key'],
+          traffic_type_id: identity['trafficTypeId'],
+          environment_id: identity['environmentId'],
+          organization_id: identity['organizationId'],
+          values: identity['values']
+        )
       end
 
       # POST /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities
       def save_all(traffic_type_id, environment_id, identities)
-        JSON.parse(RestClient.post(
+        result = JSON.parse(RestClient.post(
           "#{@config.base_uri}/trafficTypes/#{traffic_type_id}" \
           "/environments/#{environment_id}" \
           "/identities",
           identities.to_json, auth_headers).body
-        )['objects']
+        )
+
+        objects = result['objects'].map do |identity|
+          DataObjects::Identity.new(
+            key: identity['key'],
+            traffic_type_id: identity['trafficTypeId'],
+            environment_id: identity['environmentId'],
+            organization_id: identity['organizationId'],
+            values: identity['values']
+          )
+        end
+
+        {
+          objects: objects,
+          failed: result['failed'],
+          metadata: result['metadata']
+        }
       end
 
       # PATCH /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}
       def update(identity)
-        JSON.parse(RestClient.patch(
+        identity = JSON.parse(RestClient.patch(
           "#{@config.base_uri}/trafficTypes/#{identity[:traffic_type_id]}" \
           "/environments/#{identity[:environment_id]}/identities/#{identity[:key]}",
           {
             'key' => identity[:key],
             'trafficTypeId' => identity[:traffic_type_id],
             'environmentId' => identity[:environment_id],
+            'organizationId' => identity[:organization_id],
             'values' => identity[:values]
           }.to_json, auth_headers).body)
+
+        DataObjects::Identity.new(
+          key: identity['key'],
+          traffic_type_id: identity['trafficTypeId'],
+          environment_id: identity['environmentId'],
+          organization_id: identity['organizationId'],
+          values: identity['values']
+        )
       end
 
       # DELETE /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}

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

@@ -10,7 +10,13 @@ module SplitApi
 
       # GET /trafficTypes
       def list
-        JSON.parse(RestClient.get("#{@config.base_uri}/trafficTypes", auth_headers).body)
+        JSON.parse(RestClient.get("#{@config.base_uri}/trafficTypes", auth_headers).body).map do |traffic_type|
+          DataObjects::TrafficType.new(
+            id: traffic_type['id'],
+            display_attribute_id: traffic_type['displayAttributeId'],
+            name: traffic_type['name']
+          )
+        end
       end
     end
   end

data/lib/splitapi-rb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitapi-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,6 +155,11 @@ files:
 - lib/splitapi-rb.rb
 - lib/splitapi-rb/client.rb
 - lib/splitapi-rb/config.rb
+- lib/splitapi-rb/data_objects/attribute.rb
+- lib/splitapi-rb/data_objects/base_data_object.rb
+- lib/splitapi-rb/data_objects/environment.rb
+- lib/splitapi-rb/data_objects/identity.rb
+- lib/splitapi-rb/data_objects/traffic_type.rb
 - lib/splitapi-rb/exceptions/splitapi_exception.rb
 - lib/splitapi-rb/exceptions/splitapi_not_found_exception.rb
 - lib/splitapi-rb/models/attributes.rb