sensit-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a562328b0100d60525a23a958f1bdab7e450943
-  data.tar.gz: adfde68f7e6e0e448e113b6046e9c1836626a5e1
+  metadata.gz: acaa09e779dfb2934972ecc850052fde44126e23
+  data.tar.gz: b3479f2dada5a5f7d1460154d3880d4794dd43ad
 SHA512:
-  metadata.gz: 86b769430ff4a0995a3af5c4357cb1312b39a04b9c8cf80e9c7dde74266b0cd8ba81241275ce2417fe4a796ab2d32f0c3531099d63bf6a7a34ca4de379c01dd9
-  data.tar.gz: e002fa8bb5477c9e7b932cb2681cd8d14871db304e982c2b623cf72be9babb052f1dbdbe0d0b02f5b2e1305913617df4268e3a9a8a445844de335430887b625c
+  metadata.gz: 3ee542d1943ee1633dfddb71290005eb201e061615526b38fa1e35ebd96c13f7ff0128f9ab01f5c7044ad8759b266b01a3239faa7ca21088c9873bd660d6d8b0
+  data.tar.gz: c243636dceae571ea041f2eef7a2e2daef6b059fc1a5fa5b3645ffa478f1f7bb1191e2f1550b0ed7e50d4f5785bda53352007514b0bcfd7a0ff36c89480e8826

data/lib/sensit/api/feed.rb

@@ -39,10 +39,10 @@ module Sensit
       # Create a feed on a given topic. Requires authorization of **read_any_data**, or **read_application_data**.
       # '/topics/:topic_id/feeds' POST
       #
-      # data - A hash of data to be stored
-      def create(data, options = {})
+      # feed - A Hash containing `at`: a formatted time of the event. Defaults to the current time if not present.`tz`: The time zone of the time given in `at`. Defaults to UTC`data`:A hash of data to be stored
+      def create(feed, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:data] = data
+        body[:feed] = feed
 
         response = @client.post "/topics/#{@topic_id}/feeds", body, options
 
@@ -52,10 +52,10 @@ module Sensit
       # Update an associated Feed to the Topic. Requires authorization of **read_any_data**, or **read_application_data**.
       # '/topics/:topic_id/feeds/:id' PUT
       #
-      # data - A hash of data to be stored
-      def update(data, options = {})
+      # feed - A hash containing `data`:A hash of data to be stored
+      def update(feed, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:data] = data
+        body[:feed] = feed
 
         response = @client.put "/topics/#{@topic_id}/feeds/#{@id}", body, options
 

data/lib/sensit/api/field.rb

@@ -39,12 +39,10 @@ module Sensit
       # Adds a new field that feed data can be added too. Requires authorization of **manage_any_data**, or **manage_application_data**
       # '/topics/:topic_id/fields' POST
       #
-      # name - The descriptive name of the field.
-      # key - The name that the is used to identify the field in a feed
-      def create(name, key, options = {})
+      # field - A Hash containing`name`: A descriptive name of the field.`key`:The name that is used to identify the field in a feed (required).`datatype`:The type of data that is stored in the field. ie. integer, float, string, bool, datetime
+      def create(field, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
-        body[:key] = key
+        body[:field] = field
 
         response = @client.post "/topics/#{@topic_id}/fields", body, options
 
@@ -54,10 +52,10 @@ module Sensit
       # Updates the Field data and makes the corresponding changes in the index. Requires authorization of **manage_any_data**, or **manage_application_data**
       # '/api/topics/:topic_id/fields/:id' PUT
       #
-      # name - The descriptive name of the field.
-      def update(name, options = {})
+      # field - A Hash containing`name`: A descriptive name of the field.`key`:The name that is used to identify the field in a feed (required).`datatype`:The type of data that is stored in the field. ie. integer, float, string, bool, datetime
+      def update(field, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
+        body[:field] = field
 
         response = @client.put "/api/topics/#{@topic_id}/fields/#{@id}", body, options
 

data/lib/sensit/api/percolator.rb

@@ -39,12 +39,10 @@ module Sensit
       # Create a percolator on the associated Topic with the specified name and query. Requires authorization of **manage_any_percolators**, or **manage_application_percolators**.
       # '/topics/:topic_id/percolators' POST
       #
-      # name - The time zone of the time. Defaults to UTC
-      # query - A hash of data to be stored
-      def create(name, query, options = {})
+      # percolator - A Hash containing `name`: The name of the percolator(required).`query`: The query hash according to the according the the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html)
+      def create(percolator, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
-        body[:query] = query
+        body[:percolator] = percolator
 
         response = @client.post "/topics/#{@topic_id}/percolators", body, options
 
@@ -54,10 +52,10 @@ module Sensit
       # Update the query for a specific percolator. Requires authorization of **manage_any_percolators**, or **manage_application_percolators**.
       # '/topics/:topic_id/percolators/:id' PUT
       #
-      # query - A hash of data to be stored
-      def update(query, options = {})
+      # percolator - A Hash containing the `query` hash according to the according the the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html)
+      def update(percolator, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:query] = query
+        body[:percolator] = percolator
 
         response = @client.put "/topics/#{@topic_id}/percolators/#{@id}", body, options
 

data/lib/sensit/api/report.rb

@@ -39,14 +39,10 @@ module Sensit
       # Create a new report on the associated Topic which can be easily retrieved later using an id. Requires authorization of **manage_any_reports**, or **manage_application_reports**.
       # '/topics/:topic_id/reports' POST
       #
-      # name - The name of the report.
-      # query - The search query to filter the data for the facet
-      # facets - An array of facet hashes which each contain a `name` ad type of the facet along with its query hash.
-      def create(name, query, facets, options = {})
+      # report - A Hash containing `name`: The name of the report (required).`query`:The search query acccording to the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-queries.html) to filter the data for the facets (Defaults to match all).`facets`:An array of facet hashes which each contain a `name` ad type of the facet along with its query hash (required).
+      def create(report, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
-        body[:query] = query
-        body[:facets] = facets
+        body[:report] = report
 
         response = @client.post "/topics/#{@topic_id}/reports", body, options
 
@@ -56,14 +52,10 @@ module Sensit
       # Update the query, facets or name of the report. Requires authorization of **manage_any_reports**, or **manage_application_reports**.
       # '/topics/:topic_id/reports/:id' PUT
       #
-      # name - The name of the report.
-      # query - The search query to filter the data for the facet
-      # facets - An array of facet hashes which each contain a `name` ad type of the facet along with its query hash.
-      def update(name, query, facets, options = {})
+      # report - A Hash containing `name`: The name of the report (required).`query`:The search query acccording to the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-queries.html) to filter the data for the facets (Defaults to match all).`facets`:An array of facet hashes which each contain a `name` ad type of the facet along with its query hash (required).
+      def update(report, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
-        body[:query] = query
-        body[:facets] = facets
+        body[:report] = report
 
         response = @client.put "/topics/#{@topic_id}/reports/#{@id}", body, options
 

data/lib/sensit/api/subscription.rb

@@ -37,14 +37,10 @@ module Sensit
       # Create a subscription which will connect to the server and listen for feed data for any of the associated topics. Requires authorization of **manage_any_subscriptions**, or **manage_application_subscriptions**.
       # '/subscriptions' POST
       #
-      # name - The channel or name to identify the subscription.
-      # host - The ip address or host of the connection
-      # protocol - the protocol to comminivate over
-      def create(name, host, protocol, options = {})
+      # subscription - A Hash containing`name`:The channel or name to identify the subscription(required).`host`:The ip address or host of the connection(required).`protocol`:the protocol to communicate over (http, tcp, udp, mqtt) (required)`port`:The port of the connection.
+      def create(subscription, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
-        body[:host] = host
-        body[:protocol] = protocol
+        body[:subscription] = subscription
 
         response = @client.post "/subscriptions", body, options
 
@@ -54,14 +50,10 @@ module Sensit
       # Returns an object with the current configuration that Buffer is using, including supported services, their icons and the varying limits of character and schedules.  Requires authorization of **manage_any_subscriptions**, or **manage_application_subscriptions**.
       # '/subscriptions/:id' PUT
       #
-      # name - The channel or name to identify the subscription.
-      # host - The ip address or host of the connection
-      # protocol - the protocol to comminivate over
-      def update(name, host, protocol, options = {})
+      # subscription - A Hash containing`name`:The channel or name to identify the subscription(required).`host`:The ip address or host of the connection(required).`protocol`:the protocol to communicate over (http, tcp, udp, mqtt) (required)`port`:The port of the connection.
+      def update(subscription, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
-        body[:host] = host
-        body[:protocol] = protocol
+        body[:subscription] = subscription
 
         response = @client.put "/subscriptions/#{@id}", body, options
 

data/lib/sensit/api/topic.rb

@@ -35,10 +35,10 @@ module Sensit
       # Requires authorization of **manage_any_data**, or **manage_application_data**.
       # '/topics' POST
       #
-      # name - The name and id of the topic.
-      def create(name, options = {})
+      # topic - A hash containing the name/id of the topic (required) and a description of the topic.
+      def create(topic, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
+        body[:topic] = topic
 
         response = @client.post "/topics", body, options
 
@@ -48,10 +48,10 @@ module Sensit
       # Requires authorization of **manage_any_data**, or **manage_application_data**.
       # '/topics/:id' PUT
       #
-      # name - The name and id of the topic.
-      def update(name, options = {})
+      # topic - A hash containing the name/id of the topic (required) and a description of the topic.
+      def update(topic, options = {})
         body = options.has_key?(:body) ? options[:body] : {}
-        body[:name] = name
+        body[:topic] = topic
 
         response = @client.put "/topics/:id", body, options
 

data/lib/sensit/http_client.rb

@@ -16,12 +16,11 @@ module Sensit
       def initialize(auth = {}, options = {})
 
         if auth.is_a? String
-          auth = { :access_token => auth }
+          auth = { :http_header => auth }
         end
 
         @options = {
           :base => "http://sensit.herokuapp.com/api",
-          :api_version => "1",
           :user_agent => "alpaca/0.2.0 (https://github.com/pksunkara/alpaca)"
         }
 

data/lib/sensit/http_client/auth_handler.rb

@@ -7,8 +7,7 @@ module Sensit
     # AuthHandler takes care of devising the auth type and using it
     class AuthHandler < Faraday::Middleware
 
-      URL_SECRET = 2
-      URL_TOKEN = 3
+      HTTP_HEADER = 1
 
       def initialize(app, auth = {}, options = {})
         @auth = auth
@@ -20,13 +19,8 @@ module Sensit
           auth = get_auth_type
           flag = false
 
-          if auth == URL_SECRET
-            env = url_secret env
-            flag = true
-          end
-
-          if auth == URL_TOKEN
-            env = url_token env
+          if auth == HTTP_HEADER
+            env = http_header env
             flag = true
           end
 
@@ -41,32 +35,18 @@ module Sensit
       # Calculating the Authentication Type
       def get_auth_type()
 
-        if @auth.has_key?(:client_id) and @auth.has_key?(:client_secret)
-          return URL_SECRET
-        end
-
-        if @auth.has_key?(:access_token)
-          return URL_TOKEN
+        if @auth.has_key?(:http_header)
+          return HTTP_HEADER
         end
 
         return -1
       end
 
-      # OAUTH2 Authorization with client secret
-      def url_secret(env)
-        query = {
-          :client_id => @auth[:client_id],
-          :client_secret => @auth[:client_secret]
-        }
+      # Authorization with HTTP header
+      def http_header(env)
+        env[:request_headers]["Authorization"] = "Bearer #{@auth[:http_header]}"
 
-        merge_query env, query
-      end
-
-      # OAUTH2 Authorization with access token
-      def url_token(env)
-        query = { :access_token => @auth[:access_token] }
-
-        merge_query env, query
+        return env
       end
 
       def query_params(url)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensit-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Christopher Waddington
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday