da_face 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2cc7da25ff983a44979fc89589b3ba941ec8fe8
+  data.tar.gz: 027c7b27941c2022d1a2e3d1de208a5f82ded031
+SHA512:
+  metadata.gz: add136c3162345f1c338d70943513d6fa505abbaa2c139bc7bb64bb7e31c101df625baf93a408c84ee42654f29ba2a646adafe4b6457bb769d4f0a084561b068
+  data.tar.gz: 1a18b8987549558d183c855ed4efb8ad15102a747f8a7e3293d59b70e4efffaebf7f3c711b84c14780dd141ddd843528a40dac9a2792af0d93f6d1919ecc2730

data/.gitignore

@@ -0,0 +1,20 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+.bundle
+.watchr
+.redcar
+.project
+db/*.sqlite3
+log/*.log*
+tmp/*
+*~
+*#*#*
+.DS_Store
+*.swp
+*.iml
+.rvmrc
+coverage

data/.ruby-gemset

@@ -0,0 +1 @@
+da_face

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in da_face.gemspec
+gemspec
+
+gem 'simplecov', :require => false, :group => :test

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    da_face (0.0.1)
+      excon
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    excon (0.39.6)
+    json (1.8.1)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.5)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  da_face!
+  pry
+  rake (~> 10.0)
+  rspec
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rayko
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# DaFace
+
+DaFace is an interface to interact with Datasift API. The good thing about DaFace is that it will present you with pretty data that you can use on your application.
+
+# DaFace?
+
+[Da]tasift Inter[face] -> DaFace
+
+## Installation
+
+(It will probably be pretty much like this, but this is still WIP)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'da_face'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install da_face
+
+## Usage
+
+Configuration:
+
+    DaFace.configure do |config|
+      config.user = 'SomeUser'
+      config.api_key = 'some_long_key'
+      config.api_host = 'http://ds_custom_api_host'
+      config.api_path_prefix = '/v1'
+      config.adapter_class = 'DaFace::Api::Adapters::ExconAdapter'
+    end
+
+This is all you can configure for DaFace. The required configurations are user and api_key, you can leave the rest because it has default values for those.
+
+Configuration Details:
+
+- config.user: username in Datasift to construct the Authorization header.
+- config.api_key: the api key hash given to get acess to their API.
+- config.api_host: the base host of where the API is, it defaults to http://api.datasift.com
+- config.api_path_prefix: a prefix to pre-pend to outgoing requests, for now it's used to set API version. It defauls to '/v1'.
+- config.adapter_class: tells DaFace which adapter to use. It defauls to Daface::Api::Adapters::ExconAdapter, and it's the only one available for now. You can write your own adapter for RestClient, or any other HTTP interface.
+
+
+Push Interface:
+
+You can use DaFace to interact with the Push endpoints of the API, and define or handle subscriptions.
+You can create a subscription with:
+
+    subscription = Daface.create_subscription :name => 'Test', :output_params => {:auth => {:type => 'none'}, :url => 'http://somewhere.com', :delivery_frequency => 10}
+
+You can then do other stuff with the subscription:
+
+    subscription.validate # performs a validation of the output params
+    subscription.create   # creates the subscription
+    subscription.log      # returns a list of recent events in the log
+    subscription.pause    # sends a pause command with the subscription id
+    subscription.resume   # sends a resume command
+    subscription.delete   # deletes the subscription
+
+
+You can for example get a list of subscriptions:
+
+    DaFace.get_subscriptions
+
+And then perform any needed operation from the Array you get. All objects inside will be DaFace::Api::PushSubscription objects.
+
+Parsers:
+
+DaFace provides some parsers to deal with the push data comming from Datasift. The support of different Datasift objects is limited thought, but for each interaction you get, DaFace will transform it into a DaObject, which will provide you accessors to different data inside the interaction:
+
+    da_object.interaction # interaction information
+    da_object.twitter # twitter information
+
+Each interaction sub-object, like twitter, will have more info inside:
+
+    da_object.twitter.tweet    # a tweet
+    da_object.twitter.tweet.id # the id of the tweet
+
+
+Notes:
+
+As mentioned avobe, support is limited, so make sure DaFace suits your needs before implementing. There's still some work to be done, such as creating some more adapters, and make it easier to use DaFace internals.
+
+Comments, complains, recommendations, ideas, are all welcome.
+
+Supported Datasift Objects:
+
+- Interaction
+- Demographic
+- Language
+- Links
+- Salience
+- Twitter
+- Twitter Delete Notifications
+- Twitter User Notifications
+
+For the case of Twitter objects, there's support for parsing a normal tweet or retweets. The "tweet" method of the Twitter object will always return the relevant tweet, which will be the normal tweet, or the retweet for the case of a retweet. The original tweet will be available in the "retweeted" method.
+
+## Contributing
+
+1. Fork it ( https://github.com/rayko/da_face/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write some specs or update existing ones
+4. Write some code
+5. Make sure all specs (new and older) pass
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/da_face.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'da_face/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "da_face"
+  spec.version       = DaFace::VERSION
+  spec.authors       = ["Rayko"]
+  spec.email         = ["rayko.drg@gmail.com"]
+  spec.summary       = %q{DataSift Interface.}
+  spec.description   = %q{Interface to interact with Datasift API and get pretty data from them.}
+  spec.homepage      = "https://github.com/rayko/da_face"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "api"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "json"
+  spec.add_dependency "excon"
+end

data/lib/da_face/api/adapter.rb

@@ -0,0 +1,42 @@
+module DaFace
+  module Api
+    class Adapter
+      include DaFace::Utilities
+
+      attr_reader :connection
+
+      def initialize adapter_class = DaFace.configuration.adapter_class
+        @connection = adapter_class.new
+      end
+
+      # TODO Handle headers for rate limits
+      # TODO Handle status codes
+
+      # Performs a get operation
+      #
+      # params is a level 1 hash that should contain params for url
+      def get path, params={}
+        response = connection.get path, params
+        return symbolize_keys(response.keys, response)
+      end
+
+      # Performs a post operation
+      #
+      # payload is a hash that will be parsed to json and sent as body
+      def post path, payload
+        response = connection.post path, payload
+        return true if response.empty?
+        return symbolize_keys(response.keys, response)
+      end
+      
+      # Performs a put operation
+      #
+      # payload is a hash that will be parsed to json and sent as body
+      def put path, payload
+        response = connection.put path, payload
+        return true if response.empty?
+        return symbolize_keys(response.keys, response)
+      end
+    end
+  end
+end

data/lib/da_face/api/adapters/base.rb

@@ -0,0 +1,59 @@
+module DaFace
+  module Api
+    module Adapters
+      class Base
+        attr_reader :host, :path_prefix, :user, :api_key
+
+        def initialize
+          @host = DaFace.configuration.api_host
+          @path_prefix = DaFace.configuration.api_path_prefix
+          @user = DaFace.configuration.user
+          @api_key = DaFace.configuration.api_key
+
+          raise DaFace::AdapterError.new('Missing user for authentication') unless @user
+          raise DaFace::AdapterError.new('Missing api_key for authentication') unless @api_key
+        end
+
+        # Constructs default headers for operations
+        def default_headers
+          {
+            'Authorization' => api_auth_header,
+            'Accept' => 'application/json'
+          }
+        end
+
+        def get_headers
+          default_headers
+        end
+
+        def post_headers
+          default_headers.merge({'Content-Type' => 'application/x-www-form-urlencoded'})
+        end
+
+        def encode_form payload
+          URI.encode_www_form(payload)
+        end
+
+        # Constructs the base api path for Datasift
+        def api_path
+          "#{self.host}#{self.path_prefix}"
+        end
+        
+        # Constructs the auth header for Datasift
+        def api_auth_header
+          "#{self.user}:#{self.api_key}"
+        end
+        
+        # Transforms a level 1 hash to valid url params
+        #
+        # This will return something like "?something=thing" to be appended 
+        # to url path
+        def url_params params
+          '?' + URI.encode(params.collect{ |key, value| "#{key}=#{value}"}.join('&')) unless params.empty?        
+        end
+
+
+      end
+    end
+  end
+end

data/lib/da_face/api/adapters/em_http_request_adapter.rb

@@ -0,0 +1,8 @@
+module DaFace
+  module Api
+    module Adapters
+      class EmHttpRequestAdapter < DaFace::Api::Adapters::Base
+      end
+    end
+  end
+end

data/lib/da_face/api/adapters/excon_adapter.rb

@@ -0,0 +1,33 @@
+module DaFace
+  module Api
+    module Adapters
+      class ExconAdapter < DaFace::Api::Adapters::Base
+        def connection
+          Excon.new self.api_path
+        end
+
+        def get path, params={}
+          response = connection.get :path => "#{path}#{url_params(params)}", :headers => get_headers
+          return parse_body(response.body)
+        end
+
+        def post path, payload
+          response = connection.post :path => path, :body => encode_form(payload), :headers => post_headers
+          return {} if response.body.empty?
+          return parse_body(response.body)
+        end
+        
+        def put path, payload
+          response = connection.put :path => "#{path}", :body => encode_form(payload), :headers => post_headers
+          return {} if response.body.empty?
+          return parse_body(response.body)
+        end
+
+        def parse_body body
+          JSON.parse(body)
+        end
+        
+      end
+    end
+  end
+end

data/lib/da_face/api/push.rb

@@ -0,0 +1,77 @@
+module DaFace
+  module Api
+    class Push
+      # TODO Handle error cases in a better way (raise)
+      # TODO Handle empty responses
+
+      # Validates output_params for a subscription.
+      def self.validate output_config
+        response = connection.post 'push/validate', output_config
+        raise_push_error_if_error response
+        return response
+      end
+      
+      def self.create subscription
+        response = connection.post 'push/create', subscription
+        raise_push_error_if_error response
+        return response
+      end
+      
+      def self.update subscription
+        response = connection.put 'push/update', subscription
+        raise_push_error_if_error response
+        return response
+      end
+      
+      def self.pause subscription_id
+        response = connection.put 'push/pause', {:id => subscription_id}
+        raise_push_error_if_error response
+        return response
+      end
+      
+      def self.resume subscription_id
+        response = connection.put 'push/resume', {:id => subscription_id}
+        raise_push_error_if_error response
+        return response
+      end
+      
+      def self.stop subscription_id
+        response = connection.put 'push/stop', {:id => subscription_id}
+        raise_push_error_if_error response
+        return response
+      end
+      
+      def self.delete subscription_id
+        response = connection.put 'push/delete', {:id => subscription_id}
+        raise_push_error_if_error response
+        return response
+      end
+      
+      # TODO Make this work with pagination
+      def self.log subscription_id
+        response = connection.get 'push/log', {:id => subscription_id}
+        raise_push_error_if_error response
+        return response
+      end
+
+      # TODO Make this work with pagination
+      def self.get params={}
+        response = connection.get 'push/get', params
+        raise_push_error_if_error response
+        return response
+      end
+
+      def self.connection
+        DaFace::Api::Adapter.new
+      end
+
+      private
+      def self.raise_push_error_if_error response
+        if response.kind_of?(Hash) && response.keys.include?(:error)
+          raise DaFace::PushError.new(response[:message]) if response.keys.include? :message
+          raise DaFace::PushError.new(response[:error]) if response.keys.include? :error
+        end
+      end
+    end
+  end
+end

data/lib/da_face/api/push_log.rb

@@ -0,0 +1,11 @@
+module DaFace
+  module Api
+    class PushLog
+      attr_reader :count, :entries
+      def initialize data
+        @count = data[:count]
+        @entries = data[:log_entries].collect{|e| DaFace::Api::PushLogEntry.new(e)}
+      end
+    end
+  end
+end

data/lib/da_face/api/push_log_entry.rb

@@ -0,0 +1,15 @@
+module DaFace
+  module Api
+    class PushLogEntry
+      attr_reader :request_time, :success, :subscription_id, :message
+
+      def initialize data
+        @request_time = Time.at data[:request_time]
+        @sucess = data[:success]
+        @subscription_id = data[:subscription_id]
+        @message = data[:message]
+      end
+    end
+    
+  end
+end

data/lib/da_face/api/push_subscription.rb

@@ -0,0 +1,141 @@
+module DaFace
+  module Api
+    class PushSubscription
+      include DaFace::Utilities
+
+      attr_accessor :name, :hash, :initial_status, :start, :end,
+                    :output_params, :output_type, :playback_id
+
+      attr_reader :id, :created_at, :user_id, :hash_type, :status, :last_request, 
+                  :last_success, :remaining_bytes, :lost_data
+
+      def initialize data={}
+        assign_attributes! data
+        normalize_attributes!
+        return self
+      end
+
+      def assign_attributes! data
+        allowed_attributes.each do |attr|
+          unless data[attr].nil?
+            self.instance_variable_set("@#{attr}".to_sym, data[attr])
+          end
+        end
+      end
+
+      def update! data={}
+        params = data.delete :output_params
+        assign_attributes! data
+        self.output_params.merge! params
+        normalize_attributes!
+        return self
+      end
+
+      def allowed_attributes
+        [:name, :hash, :initial_status, :start, :end,
+         :output_params, :output_type, :playback_id,
+         :id, :created_at, :user_id, :hash_type, :status, :last_request, 
+         :last_success, :remaining_bytes, :lost_data]
+      end
+
+      def normalize_attributes!
+        @last_request = parse_timestamp(@last_request) if @last_request
+        @last_success = parse_timestamp(@last_success) if @last_success
+        @start = (@start && @start > 0) ? parse_timestamp(@start) : nil
+        @end = (@end && @end > 0) ? parse_timestamp(@end) : nil
+        @created_at = parse_timestamp(@created_at) if @created_at
+      end
+
+      def generate_config
+        config = {}
+        config['name']           = self.name if self.name
+        config['output_type']    = self.output_type if self.output_type
+        config['initial_status'] = self.initial_status if self.initial_status
+        config['hash']           = self.hash if self.hash
+        config['playback_id']    = self.playback_id if self.playback_id
+        config['start']          = self.start.to_i if self.start
+        config['end']            = self.end.to_i if self.end
+
+        config.merge! self.output_params_config if self.output_params
+        config
+      end
+
+      def lost_data?
+        self.lost_data
+      end
+
+      def output_params_config
+        params = self.output_params.clone
+        auth = params.delete :auth
+        config = {}
+        params.each do |key, value|
+          config["output_params.#{key}"] = value
+        end
+        auth.each do |key, value|
+          config["output_params.auth.#{key}"] = value
+        end unless auth.nil?
+
+        config
+      end
+
+      def output_config
+        config = {}
+        config['output_type'] = self.output_type
+        config.merge! self.output_params_config
+
+        config
+      end
+
+      def update 
+        params = {'id' => self.id, 'name' => self.name}.merge(self.output_config)
+        data = DaFace::Api::Push.update params
+        update! data
+      end
+
+      def validate
+        DaFace::Api::Push.validate self.output_config
+      end
+
+      def create
+        data = DaFace::Api::Push.create self.generate_config
+        return data if data.keys.include? :error
+        update! data
+      end
+      
+      def pause
+        DaFace::Api::Push.pause self.id
+      end
+      
+      def resume
+        DaFace::Api::Push.resume self.id
+      end
+
+      def stop
+        DaFace::Api::Push.stop self.id
+      end
+      
+      def delete
+        DaFace::Api::Push.delete self.id
+      end
+
+      def log
+        data = DaFace::Api::Push.log self.id
+        return data if data.keys.include? :error
+        DaFace::Api::PushLog.new data
+      end
+
+      def get
+        data = DaFace::Api::Push.get :id => self.id
+        return data if data.keys.include? :error
+        update! data
+      end
+
+      def self.get_all
+        data = DaFace::Api::Push.get
+        return data if data.keys.include? :error
+        data[:subscriptions].collect{|d| new(d)}
+      end
+
+    end
+  end
+end

data/lib/da_face/configuration.rb

@@ -0,0 +1,11 @@
+module DaFace
+  class Configuration
+    attr_accessor :api_path_prefix, :api_host, :user, :api_key, :adapter_class
+
+    def initialize
+      @api_path_prefix = '/v1'
+      @api_host = 'http://api.datasift.com'
+      @adapter_class = DaFace::Api::Adapters::ExconAdapter
+    end
+  end
+end