splitapi-rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a1eb207ee1935989e0fe0c5d4577922667a5c98
+  data.tar.gz: 3a36139c534cedff98a4953872172d4f0470188b
+SHA512:
+  metadata.gz: bd68391a7c70338900949f4f3e54f2f85509948b129c1c7dc15db7a09ee71c5acb44c73b99e600a7f82e78c46c14fb21d208849ae9019b5091a47931519cceb6
+  data.tar.gz: fe8e6f39a25c6e63f284b1eeadd2ebe7e15f0c3c9e931dcf58b3537154e547b9e9e6f83e1d2d704cff013c315bfb10e8bae8546ba719890baa850f9c36d199c2

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in splitclient-rb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    splitapi-rb (1.0.0)
+      json (~> 1.8)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.2)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (1.8.6)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    public_suffix (2.0.5)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  byebug (~> 9)
+  pry (~> 0.10)
+  pry-byebug (~> 3.4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  splitapi-rb!
+  webmock (~> 2.3)
+
+BUNDLED WITH
+   1.14.6

data/NEWS

@@ -0,0 +1,3 @@
+1.0.0
+
+Initial release

data/README.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/lib/splitapi-rb.rb

@@ -0,0 +1,18 @@
+require 'splitapi-rb/exceptions/splitapi_exception'
+require 'splitapi-rb/exceptions/splitapi_not_found_exception'
+
+require 'splitapi-rb/version'
+require 'splitapi-rb/client'
+require 'splitapi-rb/config'
+
+require 'splitapi-rb/models/base_model'
+require 'splitapi-rb/models/attributes'
+require 'splitapi-rb/models/environments'
+require 'splitapi-rb/models/identities'
+require 'splitapi-rb/models/traffic_types'
+
+module SplitApi
+  def self.root
+    File.dirname(__dir__)
+  end
+end

data/lib/splitapi-rb/client.rb

@@ -0,0 +1,14 @@
+module SplitApi
+  class Client
+    attr_reader :attributes, :environments, :identities, :traffic_types
+
+    def initialize(params)
+      @config = SplitApi::Config.new(params)
+
+      @attributes = SplitApi::Models::Attributes.new(@config)
+      @environments = SplitApi::Models::Environments.new(@config)
+      @identities = SplitApi::Models::Identities.new(@config)
+      @traffic_types = SplitApi::Models::TrafficTypes.new(@config)
+    end
+  end
+end

data/lib/splitapi-rb/config.rb

@@ -0,0 +1,13 @@
+module SplitApi
+  class Config
+    # 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]
+      @api_key = opts[:api_key]
+    end
+  end
+end

data/lib/splitapi-rb/exceptions/splitapi_exception.rb

@@ -0,0 +1,4 @@
+module SplitApi
+  class SplitApiException < StandardError
+  end
+end

data/lib/splitapi-rb/exceptions/splitapi_not_found_exception.rb

@@ -0,0 +1,4 @@
+module SplitApi
+  class SplitApiNotFoundException < SplitApiException
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'rest-client'
+require 'json'
+
+module SplitApi
+  module Models
+    class Attributes < BaseModel
+      def initialize(config)
+        @config = config
+      end
+
+      # GET /trafficTypes/{traffic_type_id}/schema
+      def list(traffic_type_id)
+        JSON.parse(
+          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
+      def save(attribute)
+        JSON.parse(
+          RestClient.put(
+            "#{@config.base_uri}/trafficTypes/#{attribute[:traffic_type_id]}/schema",
+            {
+              'id' => attribute[:id],
+              'trafficTypeId' => attribute[:traffic_type_id],
+              'displayName' => attribute[:display_name],
+              '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}
+      def delete(traffic_type_id, attribute_id)
+        RestClient.delete(
+          "#{@config.base_uri}/trafficTypes/#{traffic_type_id}" \
+          "/schema/#{attribute_id}",
+          auth_headers) == 'true'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module SplitApi
+  module Models
+    class BaseModel
+      protected
+
+      def to_underscore(str)
+        str.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+
+      def auth_headers
+        { Authorization: "Bearer #{@config.api_key}", content_type: :json, accept: :json }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'rest-client'
+require 'json'
+
+module SplitApi
+  module Models
+    class Environments < BaseModel
+      def initialize(config)
+        @config = config
+      end
+
+      # 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require 'rest-client'
+require 'json'
+
+module SplitApi
+  module Models
+    class Identities < BaseModel
+      def initialize(config)
+        @config = config
+      end
+
+      # PUT /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}
+      def save(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],
+            'values' => identity[:values]
+          }.to_json, auth_headers).body).map { |k, v| [to_underscore(k), v] }.to_h
+      end
+
+      # POST /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities
+      def save_all(traffic_type_id, environment_id, identities)
+        JSON.parse(RestClient.post(
+          "#{@config.base_uri}/trafficTypes/#{traffic_type_id}" \
+          "/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
+      end
+
+      # PATCH /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}
+      def update(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],
+            'values' => identity[:values]
+          }.to_json, auth_headers).body).map { |k, v| [to_underscore(k), v] }.to_h
+      end
+
+      # DELETE /trafficTypes/{traffic_type_id}/environments/{environment_id}/identities/{key}
+      def delete(traffic_type_id, environment_id, key)
+        RestClient.delete(
+          "#{@config.base_uri}/trafficTypes/#{traffic_type_id}/environments/" \
+          "#{environment_id}/identities/#{key}",
+          auth_headers) == 'true'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'rest-client'
+require 'json'
+
+module SplitApi
+  module Models
+    class TrafficTypes < BaseModel
+      def initialize(config)
+        @config = config
+      end
+
+      # 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
+      end
+    end
+  end
+end

data/lib/splitapi-rb/version.rb

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

data/splitapi-rb.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'splitapi-rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'splitapi-rb'
+  spec.version       = SplitApi::VERSION
+  spec.authors       = ['Split Software']
+  spec.email         = ['pato@split.io']
+
+  spec.summary       = 'Ruby API wrapper around Split API'
+  spec.description   = 'Provides simple interface to the Split Identify API'
+  spec.homepage      = 'https://github.com/splitio/ruby-api'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug', '~> 9'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+
+  spec.add_runtime_dependency 'json', '~> 1.8'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: splitapi-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Split Software
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Provides simple interface to the Split Identify API
+email:
+- pato@split.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- NEWS
+- README.md
+- lib/splitapi-rb.rb
+- lib/splitapi-rb/client.rb
+- lib/splitapi-rb/config.rb
+- lib/splitapi-rb/exceptions/splitapi_exception.rb
+- lib/splitapi-rb/exceptions/splitapi_not_found_exception.rb
+- lib/splitapi-rb/models/attributes.rb
+- lib/splitapi-rb/models/base_model.rb
+- lib/splitapi-rb/models/environments.rb
+- lib/splitapi-rb/models/identities.rb
+- lib/splitapi-rb/models/traffic_types.rb
+- lib/splitapi-rb/version.rb
+- splitapi-rb.gemspec
+homepage: https://github.com/splitio/ruby-api
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby API wrapper around Split API
+test_files: []