sensit-client 0.0.1

checksums.yaml

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

data/lib/sensit/api/data.rb

@@ -0,0 +1,45 @@
+module Sensit
+
+  module Api
+
+    # Get the value of a specific field within a feed
+    #
+    # topic_id - The key for the parent topic
+    # feed_id - The id of the parent feed
+    # id - The key of the specific field
+    class Data
+
+      def initialize(topic_id, feed_id, id, client)
+        @topic_id = topic_id
+        @feed_id = feed_id
+        @id = id
+        @client = client
+      end
+
+      # Requires authorization of **read_any_data**, or **read_application_data**.
+      # '/topics/:topic_id/feeds/:feed_id/data/:id' GET
+      #
+      def find(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/feeds/#{@feed_id}/data/#{@id}", body, options
+
+        return response
+      end
+
+      # Update a specific value of a field within a feed with the data passed in. Requires authorization of **read_any_data**, or **read_application_data**.
+      # '/topics/:topic_id/feeds/:feed_id/data/:id' PUT
+      #
+      def update(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.put "/topics/#{@topic_id}/feeds/#{@feed_id}/data/#{@id}", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/api/feed.rb

@@ -0,0 +1,80 @@
+module Sensit
+
+  module Api
+
+    # Returns api instance to get auxilary information about Buffer useful when creating your app.
+    #
+    # topic_id - The key for the parent topic
+    # id - The id of the feed
+    class Feed
+
+      def initialize(topic_id, id, client)
+        @topic_id = topic_id
+        @id = id
+        @client = client
+      end
+
+      # Returns a list of feeds for a given topic. Requires authorization of **read_any_data**, or **read_application_data**.
+      # '/topics/:topic_id/feeds' GET
+      #
+      def list(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/feeds", body, options
+
+        return response
+      end
+
+      # Returns a specific feed for a topic. Requires authorization of **read_any_data**, or **read_application_data**.
+      # '/topics/:topic_id/feeds/:id' GET
+      #
+      def find(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/feeds/#{@id}", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:data] = data
+
+        response = @client.post "/topics/#{@topic_id}/feeds", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:data] = data
+
+        response = @client.put "/topics/#{@topic_id}/feeds/#{@id}", body, options
+
+        return response
+      end
+
+      # Deletes the desired feed. Requires authorization of **read_any_data**, or **read_application_data**.
+      # '/topics/:topic_id/feeds/:id' DELETE
+      #
+      def delete(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.delete "/topics/#{@topic_id}/feeds/#{@id}", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/api/field.rb

@@ -0,0 +1,82 @@
+module Sensit
+
+  module Api
+
+    # .
+    #
+    # topic_id - The key for the parent topic
+    # id - Username of the user
+    class Field
+
+      def initialize(topic_id, id, client)
+        @topic_id = topic_id
+        @id = id
+        @client = client
+      end
+
+      # Get all the fields associated with a topic. Requires authorization of **read_any_data**, or **read_application_data**
+      # '/topics/:topic_id/fields' GET
+      #
+      def list(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/fields", body, options
+
+        return response
+      end
+
+      # Get a Field of the associated a topic and Id. Requires authorization of **read_any_data**, or **read_application_data**
+      # '/topics/:topic_id/fields/:id' GET
+      #
+      def find(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/fields/#{@id}", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+        body[:key] = key
+
+        response = @client.post "/topics/#{@topic_id}/fields", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+
+        response = @client.put "/api/topics/#{@topic_id}/fields/#{@id}", body, options
+
+        return response
+      end
+
+      # Deletes a field and the feed data in that field. Requires authorization of **manage_any_data**, or **manage_application_data**
+      # '/api/topics/:topic_id/fields/:id' DELETE
+      #
+      def delete(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.delete "/api/topics/#{@topic_id}/fields/#{@id}", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/api/percolator.rb

@@ -0,0 +1,82 @@
+module Sensit
+
+  module Api
+
+    # A **Percolator** is a reverse query much like a match rule which is run whenever a new feed is added. These can be used to create alerts by causing the sensit to publish the feed that was just added. A percolator query is defined by a `name` and and valid `query` according to the according the the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html).  For more information about Percolator queries please refer to the [elasticsearch percolator documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html).
+    #
+    # topic_id - The key for the parent topic
+    # id - The name of the percolator query
+    class Percolator
+
+      def initialize(topic_id, id, client)
+        @topic_id = topic_id
+        @id = id
+        @client = client
+      end
+
+      # Returns a list or percolators for a given topic. Requires authorization of **read_any_percolators**, or **read_application_percolators**.
+      # '/topics/:topic_id/percolators' GET
+      #
+      def list(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/percolators", body, options
+
+        return response
+      end
+
+      # Return a specific percolator of the associated Topic by Id. Requires authorization of **read_any_percolators**, or **read_application_percolators**.
+      # '/topics/:topic_id/percolators/:id' GET
+      #
+      def find(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/percolators/#{@id}", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+        body[:query] = query
+
+        response = @client.post "/topics/#{@topic_id}/percolators", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:query] = query
+
+        response = @client.put "/topics/#{@topic_id}/percolators/#{@id}", body, options
+
+        return response
+      end
+
+      # Delete a percolator on the associated topic. Requires authorization of **manage_any_percolators**, or **manage_application_percolators**.
+      # '/topics/:topic_id/percolators/:id' DELETE
+      #
+      def delete(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.delete "/topics/#{@topic_id}/percolators/#{@id}", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/api/report.rb

@@ -0,0 +1,88 @@
+module Sensit
+
+  module Api
+
+    # Reports are stored filter and facet queries on the **Feed** data. A report is a assigned a `name` and the `query` is any elasticsearch query which filters only the desired data for the facets (See the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-queries.html) for valid queries). A report can have many `facets` with each facet is referred to by a user defined `name`. Valid `type`'s of facet include **terms**, **range**, **histogram**, **filter**, **statistical**, **query**, **terms_stats**, or **geo_distance**. The `query` within a facet defines the field counts or statistics which the data is calculated over. See the [elasticsearch facet dsl](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets.html) for information about the various facet types and valid query fields.
+    #
+    # topic_id - The key for the parent topic
+    # id - The identifier of the report
+    class Report
+
+      def initialize(topic_id, id, client)
+        @topic_id = topic_id
+        @id = id
+        @client = client
+      end
+
+      # Get all reports for the associated Topic. Requires authorization of **read_any_reports**, or **read_application_reports**.
+      # '/topics/:topic_id/reports' GET
+      #
+      def list(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/reports", body, options
+
+        return response
+      end
+
+      # Retrieve a specific report on the associated topic by Id. Requires authorization of **read_any_reports**, or **read_application_reports**.
+      # '/topics/:topic_id/reports/:id' GET
+      #
+      def find(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/#{@topic_id}/reports/#{@id}", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+        body[:query] = query
+        body[:facets] = facets
+
+        response = @client.post "/topics/#{@topic_id}/reports", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+        body[:query] = query
+        body[:facets] = facets
+
+        response = @client.put "/topics/#{@topic_id}/reports/#{@id}", body, options
+
+        return response
+      end
+
+      # Remove a saved report on the associated Topic by Id. Requires authorization of **manage_any_reports**, or **manage_application_reports**.
+      # '/topics/:topic_id/reports/:id' DELETE
+      #
+      def delete(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.delete "/topics/#{@topic_id}/reports/#{@id}", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/api/subscription.rb

@@ -0,0 +1,86 @@
+module Sensit
+
+  module Api
+
+    # Subscriptions allows feed data to imported using a socket rather than just using the Feed REST API. By creating a subscription sensit will start to listen for feed data being imported using the specified `host` and while using the topic name as the `channel` name.
+    #
+    # id - The identifier for the subscription
+    class Subscription
+
+      def initialize(id, client)
+        @id = id
+        @client = client
+      end
+
+      # Get the list of all subscriptions for importing feed data to the associated topics. Requires authorization of **read_any_subscriptions**, or **read_application_subscriptions**.
+      # '/subscriptions' GET
+      #
+      def list(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/subscriptions", body, options
+
+        return response
+      end
+
+      # Get the information of a specific subscription. Requires authorization of **read_any_subscriptions**, or **read_application_subscriptions**.
+      # '/subscriptions/:id' GET
+      #
+      def find(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/subscriptions/#{@id}", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+        body[:host] = host
+        body[:protocol] = protocol
+
+        response = @client.post "/subscriptions", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+        body[:host] = host
+        body[:protocol] = protocol
+
+        response = @client.put "/subscriptions/#{@id}", body, options
+
+        return response
+      end
+
+      # Delete the subscription and stop listening for feed data for the associated topics. Requires authorization of **manage_any_subscriptions**, or **manage_application_subscriptions**.
+      # '/subscriptions/:id' DELETE
+      #
+      def delete(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.delete "/subscriptions/#{@id}", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/api/topic.rb

@@ -0,0 +1,76 @@
+module Sensit
+
+  module Api
+
+    # A topic is root that data is attached to. It is the equivalent of a source in searchlight/solink and acts as a table which has columns(Fields) and rows(Feeds).
+    #
+    class Topic
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Requires authorization of **read_any_data**, or **read_application_data**.
+      # '/topics' GET
+      #
+      def list(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics", body, options
+
+        return response
+      end
+
+      # Requires authorization of **read_any_data**, or **read_application_data**.
+      # '/topics/:id' GET
+      #
+      def find(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/topics/:id", body, options
+
+        return response
+      end
+
+      # Requires authorization of **manage_any_data**, or **manage_application_data**.
+      # '/topics' POST
+      #
+      # name - The name and id of the topic.
+      def create(name, options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+
+        response = @client.post "/topics", body, options
+
+        return response
+      end
+
+      # 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 = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+        body[:name] = name
+
+        response = @client.put "/topics/:id", body, options
+
+        return response
+      end
+
+      # Requires authorization of **manage_any_data**, or **manage_application_data**.
+      # '/topics/:id' DELETE
+      #
+      def delete(options = {})
+        body = options.has_key?(:body) ? options[:body] : {}
+
+        response = @client.delete "/topics/:id", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/api/user.rb

@@ -0,0 +1,28 @@
+module Sensit
+
+  module Api
+
+    # <no value>
+    #
+    class User
+
+      def initialize(client)
+        @client = client
+      end
+
+      # <no value>
+      # '/user' GET
+      #
+      def profile(options = {})
+        body = options.has_key?(:query) ? options[:query] : {}
+
+        response = @client.get "/user", body, options
+
+        return response
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/client.rb

@@ -0,0 +1,83 @@
+require "faraday"
+require "json"
+
+require "sensit/api/user"
+require "sensit/api/topic"
+require "sensit/api/feed"
+require "sensit/api/data"
+require "sensit/api/percolator"
+require "sensit/api/report"
+require "sensit/api/subscription"
+require "sensit/api/field"
+
+module Sensit
+
+  class Client
+
+    def initialize(auth = {}, options = {})
+      @http_client = Sensit::HttpClient::HttpClient.new auth, options
+    end
+
+    # <no value>
+    #
+    def user()
+      Sensit::Api::User.new @http_client
+    end
+
+    # A topic is root that data is attached to. It is the equivalent of a source in searchlight/solink and acts as a table which has columns(Fields) and rows(Feeds).
+    #
+    def topic()
+      Sensit::Api::Topic.new @http_client
+    end
+
+    # Returns api instance to get auxilary information about Buffer useful when creating your app.
+    #
+    # topic_id - The key for the parent topic
+    # id - The id of the feed
+    def feed(topic_id, id)
+      Sensit::Api::Feed.new topic_id, id, @http_client
+    end
+
+    # Get the value of a specific field within a feed
+    #
+    # topic_id - The key for the parent topic
+    # feed_id - The id of the parent feed
+    # id - The key of the specific field
+    def data(topic_id, feed_id, id)
+      Sensit::Api::Data.new topic_id, feed_id, id, @http_client
+    end
+
+    # A **Percolator** is a reverse query much like a match rule which is run whenever a new feed is added. These can be used to create alerts by causing the sensit to publish the feed that was just added. A percolator query is defined by a `name` and and valid `query` according to the according the the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html).  For more information about Percolator queries please refer to the [elasticsearch percolator documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html).
+    #
+    # topic_id - The key for the parent topic
+    # id - The name of the percolator query
+    def percolator(topic_id, id)
+      Sensit::Api::Percolator.new topic_id, id, @http_client
+    end
+
+    # Reports are stored filter and facet queries on the **Feed** data. A report is a assigned a `name` and the `query` is any elasticsearch query which filters only the desired data for the facets (See the [elasticsearch Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-queries.html) for valid queries). A report can have many `facets` with each facet is referred to by a user defined `name`. Valid `type`'s of facet include **terms**, **range**, **histogram**, **filter**, **statistical**, **query**, **terms_stats**, or **geo_distance**. The `query` within a facet defines the field counts or statistics which the data is calculated over. See the [elasticsearch facet dsl](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets.html) for information about the various facet types and valid query fields.
+    #
+    # topic_id - The key for the parent topic
+    # id - The identifier of the report
+    def report(topic_id, id)
+      Sensit::Api::Report.new topic_id, id, @http_client
+    end
+
+    # Subscriptions allows feed data to imported using a socket rather than just using the Feed REST API. By creating a subscription sensit will start to listen for feed data being imported using the specified `host` and while using the topic name as the `channel` name.
+    #
+    # id - The identifier for the subscription
+    def subscription(id)
+      Sensit::Api::Subscription.new id, @http_client
+    end
+
+    # .
+    #
+    # topic_id - The key for the parent topic
+    # id - Username of the user
+    def field(topic_id, id)
+      Sensit::Api::Field.new topic_id, id, @http_client
+    end
+
+  end
+
+end

data/lib/sensit/error/client_error.rb

@@ -0,0 +1,18 @@
+module Sensit
+
+  module Error
+
+    class ClientError < ::StandardError
+
+      attr_reader :code
+
+      def initialize(message, code)
+        @code = code
+        super message
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/error.rb

@@ -0,0 +1,9 @@
+require "sensit/error/client_error"
+
+module Sensit
+
+  module Error
+
+  end
+
+end

data/lib/sensit/http_client/auth_handler.rb

@@ -0,0 +1,91 @@
+require "base64"
+
+module Sensit
+
+  module HttpClient
+
+    # AuthHandler takes care of devising the auth type and using it
+    class AuthHandler < Faraday::Middleware
+
+      URL_SECRET = 2
+      URL_TOKEN = 3
+
+      def initialize(app, auth = {}, options = {})
+        @auth = auth
+        super(app)
+      end
+
+      def call(env)
+        if !@auth.empty?
+          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
+            flag = true
+          end
+
+          if !flag
+            raise StandardError.new "Unable to calculate authorization method. Please check"
+          end
+        end
+
+        @app.call(env)
+      end
+
+      # 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
+        end
+
+        return -1
+      end
+
+      # OAUTH2 Authorization with client secret
+      def url_secret(env)
+        query = {
+          :client_id => @auth[:client_id],
+          :client_secret => @auth[:client_secret]
+        }
+
+        merge_query env, query
+      end
+
+      # OAUTH2 Authorization with access token
+      def url_token(env)
+        query = { :access_token => @auth[:access_token] }
+
+        merge_query env, query
+      end
+
+      def query_params(url)
+        if url.query.nil? or url.query.empty?
+          {}
+        else
+          Faraday::Utils.parse_query url.query
+        end
+      end
+
+      def merge_query(env, query)
+        query = query.update query_params(env[:url])
+
+        env[:url].query = Faraday::Utils.build_query query
+
+        return env
+      end
+    end
+
+  end
+
+end

data/lib/sensit/http_client/error_handler.rb

@@ -0,0 +1,51 @@
+module Sensit
+
+  module HttpClient
+
+    # ErrorHanlder takes care of selecting the error message from response body
+    class ErrorHandler < Faraday::Middleware
+
+      def initialize(app)
+        super(app)
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |env|
+          code = env[:response].status
+          type = env[:response].headers["content-type"]
+
+          case code
+          when 500...599
+            raise Sensit::Error::ClientError.new "Error #{code}", code
+          when 400...499
+            body = Sensit::HttpClient::ResponseHandler.get_body env[:response]
+            message = ""
+
+            # If HTML, whole body is taken
+            if body.is_a? String
+              message = body
+            end
+
+            # If JSON, a particular field is taken and used
+            if type.include?("json") and body.is_a?(Hash)
+              if body.has_key? "error"
+                message = body["error"]
+              else
+                message = "Unable to select error message from json returned by request responsible for error"
+              end
+            end
+
+            if message == ""
+              message = "Unable to understand the content type of response returned by request responsible for error"
+            end
+
+            raise Sensit::Error::ClientError.new message, code
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/http_client/request_handler.rb

@@ -0,0 +1,36 @@
+module Sensit
+
+  module HttpClient
+
+    # RequestHandler takes care of encoding the request body into format given by options
+    class RequestHandler
+
+      def self.set_body(options)
+        type = options.has_key?(:request_type) ? options[:request_type] : "form"
+
+        # Encoding request body into JSON format
+        if type == "json"
+          options[:body] = options[:body].to_json
+          options[:headers]["content-type"] = "application/json"
+        end
+
+        # Encoding body into form-urlencoded format
+        if type == "form"
+          options[:body] = Faraday::Utils::ParamsHash[options[:body]].to_query
+          options[:headers]["content-type"] = "application/x-www-form-urlencoded"
+        end
+
+        # Raw body
+        if type == "raw"
+          options[:body] = options[:body].is_a?(Hash) ? "" : options[:body]
+          options[:headers].delete "content-type"
+        end
+
+        return options
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/http_client/response.rb

@@ -0,0 +1,20 @@
+module Sensit
+
+  module HttpClient
+
+    # Response object contains the response returned by the client
+    class Response
+
+      attr_accessor :body, :code, :headers
+
+      def initialize(body, code, headers)
+        @body = body
+        @code = code
+        @headers = headers
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/http_client/response_handler.rb

@@ -0,0 +1,24 @@
+module Sensit
+
+  module HttpClient
+
+    # ResponseHandler takes care of decoding the response body into suitable type
+    class ResponseHandler
+
+      def self.get_body(response)
+        type = response.headers["content-type"]
+        body = response.body
+
+        # Response body is in JSON
+        if type.include? "json"
+          body = JSON.parse body
+        end
+
+        body
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit/http_client.rb

@@ -0,0 +1,123 @@
+require "sensit/http_client/auth_handler"
+require "sensit/http_client/error_handler"
+require "sensit/http_client/request_handler"
+require "sensit/http_client/response"
+require "sensit/http_client/response_handler"
+
+module Sensit
+
+  module HttpClient
+
+    # Main HttpClient which is used by Api classes
+    class HttpClient
+
+      attr_accessor :options, :headers
+
+      def initialize(auth = {}, options = {})
+
+        if auth.is_a? String
+          auth = { :access_token => auth }
+        end
+
+        @options = {
+          :base => "http://sensit.herokuapp.com/api",
+          :api_version => "1",
+          :user_agent => "alpaca/0.2.0 (https://github.com/pksunkara/alpaca)"
+        }
+
+        @options.update options
+
+        @headers = {
+          "user-agent" => @options[:user_agent]
+        }
+
+        if @options.has_key? :headers
+          @headers.update Hash[@options[:headers].map { |k, v| [k.downcase, v] }]
+          @options.delete :headers
+        end
+
+        @client = Faraday.new @options[:base] do |conn|
+          conn.use Sensit::HttpClient::AuthHandler, auth
+          conn.use Sensit::HttpClient::ErrorHandler
+
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def get(path, params = {}, options = {})
+        request path, nil, "get", options.merge({ :query => params })
+      end
+
+      def post(path, body = {}, options = {})
+        request path, body, "post", options
+      end
+
+      def patch(path, body = {}, options = {})
+        request path, body, "patch", options
+      end
+
+      def delete(path, body = {}, options = {})
+        request path, body, "delete", options
+      end
+
+      def put(path, body = {}, options = {})
+        request path, body, "put", options
+      end
+
+      # Intermediate function which does three main things
+      #
+      # - Transforms the body of request into correct format
+      # - Creates the requests with give parameters
+      # - Returns response body after parsing it into correct format
+      def request(path, body, method, options)
+        options = @options.merge options
+
+        options[:headers] = options[:headers] || {}
+        options[:headers] = @headers.merge Hash[options[:headers].map { |k, v| [k.downcase, v] }]
+
+        options[:body] = body
+
+        if method != "get"
+          options[:body] = options[:body] || {}
+          options = set_body options
+        end
+
+        response = create_request method, path, options
+
+        body = get_body response
+
+        Sensit::HttpClient::Response.new body, response.status, response.headers
+      end
+
+      # Creating a request with the given arguments
+      #
+      # If api_version is set, appends it immediately after host
+      def create_request(method, path, options)
+        version = options.has_key?(:api_version) ? "/#{options[:api_version]}" : ""
+
+        path = "#{version}#{path}"
+
+        instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+          @client.#{method} path do |req|
+            req.body = options[:body]
+            req.headers.update(options[:headers])
+            req.params.update(options[:query]) if options[:query]
+          end
+        RUBY
+      end
+
+      # Get response body in correct format
+      def get_body(response)
+        Sensit::HttpClient::ResponseHandler.get_body response
+      end
+
+      # Set request body in correct format
+      def set_body(options)
+        Sensit::HttpClient::RequestHandler.set_body options
+      end
+
+    end
+
+  end
+
+end

data/lib/sensit-client.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+
+require "sensit/client"
+require "sensit/error"
+require "sensit/http_client"
+
+module Sensit
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: sensit-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Waddington
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: Official Sensit API library client for ruby
+email: cwadding@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sensit-client.rb
+- lib/sensit/api/data.rb
+- lib/sensit/api/feed.rb
+- lib/sensit/api/field.rb
+- lib/sensit/api/percolator.rb
+- lib/sensit/api/report.rb
+- lib/sensit/api/subscription.rb
+- lib/sensit/api/topic.rb
+- lib/sensit/api/user.rb
+- lib/sensit/client.rb
+- lib/sensit/error.rb
+- lib/sensit/error/client_error.rb
+- lib/sensit/http_client.rb
+- lib/sensit/http_client/auth_handler.rb
+- lib/sensit/http_client/error_handler.rb
+- lib/sensit/http_client/request_handler.rb
+- lib/sensit/http_client/response.rb
+- lib/sensit/http_client/response_handler.rb
+homepage: https://sensit.com
+licenses:
+- MIT
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Official Sensit API library client for ruby
+test_files: []