thisdata 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c34091bf99a2ccce9303d2c1a3952c0c1b2a990e
-  data.tar.gz: abf7211329821a58bcecf4fb21045562ea24f350
+  metadata.gz: 7dcdcde8de9993cf31989f0b1f8d44d58ecb5b12
+  data.tar.gz: 66da007fd238510bbab8967a3107a0f509e21b72
 SHA512:
-  metadata.gz: 16a1310073c2fff9cd51ca8dc9c1b60b12e389cbd3b9906ef73156d8f74090fe890c06395a8e38de1b8cf6fab455fd12f8c82af7f8e7e4c42acfcddffd036cc6
-  data.tar.gz: 3e1b4fa3752eafd370c4f398d56e3232aa1b3aa06e28ae0280331d19f05b7673294aa04c3d5301c38dd146ae14d32d84506a36faa6fdf18aa6081daa511febd6
+  metadata.gz: 6dac75e9d1960a4cf841fed96653d8b0c421ffc223a63b0e3116818b7f7e3e7c2282921a147492d53a47186901fdc4093a457d99c381e68b1059a6e81ddcf08c
+  data.tar.gz: 0cf6a8b109ca9b392be6e34e819e582a94123beef84f2e3adb41e75e14855defa014c5737feda7424f42bded94483eb692e27f90638149aa63412b43c88f3d25

data/README.md

@@ -100,6 +100,54 @@ events.first.user.id
 => "112233"
 ```
 
+#### Managing custom Rules
+You can get, create, update and delete custom rules. Note that no error handling is done
+within the API wrapper so you will need to watch out for error `messages` in the 
+response body of each call. 
+
+Create a rule
+```ruby
+# returns an OpenStruct rule
+
+rule = ThisData::Rule.create({
+  name: "Blacklist all ipv4 addresses",
+  description: "Blocks every possible ipv4 address",
+  type: "blacklist",
+  target: "location.ip",
+  filters: ["0.0.0.0/0"]
+})
+
+puts rule.id 
+puts rule.name
+...
+```
+
+List all rules
+```ruby
+rules = ThisData::Rule.all
+```
+
+Find a single rule
+```ruby
+rule = ThisData::Rule.find(1234567)
+```
+
+Update a rule
+```ruby
+# id is reqired. Other params are optional
+
+ThisData::Rule.update({
+  id: "123456",
+  filters: ["0.0.0.0/0",""]
+})
+```
+
+Delete a rule
+```ruby
+# returns bool
+ThisData::Rule.delete(123456)
+```
+
 ### Rails
 
 #### Set Up

data/lib/this_data/client.rb

@@ -48,6 +48,12 @@ module ThisData
       self.class.post(path, query: query, headers: @headers, body: body)
     end
 
+    # Perform a DELETE request against the ThisData API, with the API key
+    # prepopulated
+    def delete(path)
+      self.class.delete(path, query: @default_query, headers: @headers)
+    end
+
     private
 
       def version

data/lib/this_data/rule.rb

@@ -0,0 +1,62 @@
+# A wrapper for the GET /rules API
+#
+# Note: No error handling is included in this wrapper
+#
+module ThisData
+  class Rule
+
+    # Fetch an array of Rules from the ThisData API
+    # Available options can be found at
+    #   http://help.thisdata.com/docs/v1rules
+    #
+    # Returns: Array of OpenStruct Rule objects
+    def self.find(id)
+      response = ThisData::Client.new.get("#{ThisData::RULES_ENDPOINT}/#{id}")
+      OpenStruct.new( response.parsed_response)
+    end
+
+    # Fetch an array of Rules from the ThisData API
+    # Available options can be found at
+    #   http://help.thisdata.com/docs/v1rules
+    #
+    # Returns: Array of OpenStruct Rule objects
+    def self.all
+      response = ThisData::Client.new.get(ThisData::RULES_ENDPOINT)
+      response.parsed_response.collect do |rule_hash|
+        OpenStruct.new(rule_hash)
+      end
+    end
+
+    # Create a new rule on the ThisData API
+    # Available options can be found at
+    #   http://help.thisdata.com/docs/v1rules-1
+    #
+    # Returns: OpenStruct Rule object
+    def self.create(rule)
+      response = ThisData::Client.new.post(ThisData::RULES_ENDPOINT, body: JSON.generate(rule))
+      OpenStruct.new(response.parsed_response)
+    end
+
+    # Update a rule on the ThisData API
+    # Available options can be found at
+    #   http://help.thisdata.com/docs/v1rulesid-1
+    #
+    # Returns: OpenStruct Rule object
+    def self.update(rule)
+      rule_id = OpenStruct.new(rule).id
+      response = ThisData::Client.new.post("#{ThisData::RULES_ENDPOINT}/#{rule_id}", body: JSON.generate(rule))
+      OpenStruct.new(response.parsed_response)
+    end
+
+    # Delete a rule on the ThisData API
+    # Available options can be found at
+    #   http://help.thisdata.com/docs/v1rulesid-2
+    #
+    # Returns: OpenStruct Rule object
+    def self.destroy(id)
+      response = ThisData::Client.new.delete("#{ThisData::RULES_ENDPOINT}/#{id}")
+      response.code.eql?(204)
+    end
+
+  end
+end

data/lib/this_data/version.rb

@@ -1,3 +1,3 @@
 module ThisData
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/this_data.rb

@@ -2,6 +2,7 @@ require "httparty"
 require "logger"
 require "json"
 
+require "this_data/rule"
 require "this_data/event"
 require "this_data/version"
 require "this_data/verbs"
@@ -15,6 +16,7 @@ module ThisData
   # API Endpoint Paths
   EVENTS_ENDPOINT   = '/events'
   VERIFY_ENDPOINT   = '/verify'
+  RULES_ENDPOINT    = '/rules'
 
   # Risk level constants, defined at http://help.thisdata.com/docs/apiv1verify#what-does-the-risk_level-mean
   RISK_LEVEL_GREEN  = 'green'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thisdata
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - ThisData Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-26 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -132,6 +132,7 @@ files:
 - lib/this_data/client.rb
 - lib/this_data/configuration.rb
 - lib/this_data/event.rb
+- lib/this_data/rule.rb
 - lib/this_data/track_request.rb
 - lib/this_data/verbs.rb
 - lib/this_data/version.rb
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for ThisData's Login Intelligence API