driftrock-service 0.1.8

data/.gitignore

@@ -0,0 +1,20 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swo
+*.swp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Max
+
+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,29 @@
+# Driftrock::Service
+
+Gem to make it easier to talk to the driftrock api from your app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'driftrock-service'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install driftrock-service
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require 'driftrock-service'
+require 'rspec/core/rake_task'
+require 'rspec'
+
+RSpec::Core::RakeTask.new('spec')
+
+#require 'rake/testtask'
+#
+#Rake::TestTask.new do |t|
+#  t.libs << 'test'
+#end
+#
+#desc "Run tests"
+#task :default => :test

data/driftrock-service.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'driftrock-service/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "driftrock-service"
+  gem.version       = Driftrock::Service::VERSION
+  gem.authors       = ["Max"]
+  gem.email         = ["max.dupenois@forward.co.uk"]
+  gem.description   = %q{Gem for talking to the driftrock apu}
+  gem.summary       = %q{Maintains the api endpoints and the calls to them with authorisation, etc.}
+  gem.homepage      = "https://github.com/forward/driftrock-service"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency 'httparty'
+  gem.add_development_dependency 'rspec'
+end

data/lib/driftrock-service/api/administrative.rb

@@ -0,0 +1,87 @@
+module Driftrock
+  module Service
+    module Api
+      module Administrative 
+        include Driftrock::Service::Api
+
+        module URLs
+          BASE     = '/dashboard_api'
+          USERS    = BASE+'/user'
+          CHANNELS = BASE+'/channel'
+          APPS     = BASE+'/driftrock_app'
+        end
+        
+        def list_apps
+          get(URLs::APPS+"/")
+        end 
+        
+        def get_app(app_id)
+          get(URLs::APPS+"/#{app_id}")
+        end
+
+        def add_twitter_details(username, password)
+          post(URLs::CHANNELS+"/temp/connect_twitter", {username: username, password: password})
+        end
+
+        def auth_token(app_id, timestamp, company_id)
+          response = post(URLs::APPS+"/#{app_id}/auth_token", 
+               {company_id: company_id, timestamp: timestamp})
+          response['token']
+        end
+
+        def activate_app(app_id)
+          post(URLs::APPS+"/#{app_id}/activate")
+        end
+
+        def channel_types
+          get(URLs::CHANNELS+"/types")
+        end
+
+        def add_channel(channel_name, channel_data)
+          post(URLs::CHANNELS+"/#{channel_name}", channel_data) 
+        end
+
+        def get_channel(channel_name)
+          get(URLs::CHANNELS+"/#{channel_name}") 
+        end
+
+        def add_profile_for_channel(channel_name, profile_id)
+          post(URLs::CHANNELS+"/#{channel_name}/profile", {profile_id: profile_id}) 
+        end
+  
+        def new_token_for_channel(channel_name, token)
+          put(URLs::CHANNELS+"/#{channel_name}/profile", token) 
+        end
+
+        def driftrock_login(validation_data)
+          post(URLs::USERS+"/login", validation_data) 
+        end
+
+        def new_account(user_data)
+          post(URLs::USERS+"/new", user_data) 
+        end
+     
+        def get_user(user_session_id)
+          get(URLs::USERS+"/#{user_session_id}") 
+        end
+ 
+        def get_company(company_id)
+          get(URLs::USERS+"/company/#{company_id}") 
+        end
+        
+        def get_companies
+          get(URLs::USERS+"/companies") 
+        end
+
+        def user_admin?(user_session_id)
+          response = get(URLs::USERS+"/#{user_session_id}/is_admin") 
+          response['is_admin'] =~ /true/
+        end
+
+        def new_company(company_data)
+          post(URLs::COMPANIES+"/new", company_data) 
+        end
+      end
+    end
+  end
+end

data/lib/driftrock-service/api/data.rb

@@ -0,0 +1,16 @@
+module Driftrock
+  module Service
+    module Api
+      module Data
+        include Driftrock::Service::Api
+        ENDPOINT = "/api"
+
+        def driftrock_data(channel, opts ={})
+          get(ENDPOINT+'/'+channel.to_s, opts)
+        end
+
+      end
+    end
+  end
+end
+

data/lib/driftrock-service/api/puller.rb

@@ -0,0 +1,66 @@
+module Driftrock
+  module Service
+    module Api
+      module Puller
+        include Driftrock::Service::Api
+        module URLs
+          BASE  = "/puller_api"
+          TOKENS= BASE+"/client_tokens"
+          ADVERT_STATES = BASE+"/advert_states"
+          CONVERSION_STATES = BASE+"/conversion_states"
+        end
+
+        def tokens(channel)
+          get(URLs::TOKENS+"/#{channel}")
+        end
+
+        def temp_auth_tokens(channel)
+          get(URLs::TOKENS+"/#{channel}/temp")
+        end
+
+        def refresh_token(channel, company_id, profile_id, 
+                          access_token, refresh_token,
+                          expires_in, expires_at
+                         )
+          post(URLs::TOKENS+"/refreshed/#{channel}", 
+               {
+                 company_id: company_id,
+                 profile_id: profile_id,
+                 access_token: access_token,
+                 refresh_token: refresh_token,
+                 expires_in: expires_in,
+                 expires_at: expires_at.strftime(datetime_format)
+               })
+        end
+
+        def advert_states(channel, date, company_id, profile_id, states)
+          post(URLs::ADVERT_STATES+"/#{channel}", 
+            {
+              date: date.strftime(datetime_format),
+              company_id: company_id,
+              profile_id: profile_id,
+              advert_states: states
+            }
+          )
+        end
+
+        def conversion_states(channel, date, company_id, profile_id, states)
+          post(URLs::CONVERSION_STATES+"/#{channel}", 
+            {
+              date: date.strftime(datetime_format),
+              company_id: company_id,
+              profile_id: profile_id,
+              conversion_states: states
+            }
+          )
+
+        end
+
+        def datetime_format
+          "%Y-%m-%d %H:%M:%S %z"
+        end
+      end
+    end
+  end
+end
+

data/lib/driftrock-service/api.rb

@@ -0,0 +1,46 @@
+module Driftrock
+  module Service
+    module Api
+      def get(url, opts={})
+        api_request do |user_id, company_id|
+          Driftrock::Service::Connector.get_from_api(
+            url, user_id, company_id, opts
+          )
+        end
+      end
+      
+      def put(url, opts={})
+        api_request do |user_id, company_id|
+          Driftrock::Service::Connector.put_to_api(
+            url, user_id, company_id, opts
+          )
+        end
+      end
+
+      def post(url, opts={})
+        api_request do |user_id, company_id|
+          Driftrock::Service::Connector.post_to_api(
+            url, user_id, company_id, opts
+          )
+        end
+      end
+
+      private
+      def api_request
+        user_id, company_id = nil
+        begin
+          sess = session.reduce({}){|h, (k, v)| h[k.to_sym] = v; h}
+          user_id = sess[:user_id]
+          company_id = sess[:company_id]
+        rescue => e
+        end
+        response = yield(user_id, company_id)
+        if response['errors']
+          raise Errors::DriftrockError.new(response['errors'])
+        else
+          response['data']
+        end
+      end 
+    end
+  end
+end

data/lib/driftrock-service/config.rb

@@ -0,0 +1,36 @@
+module Driftrock
+  module Service
+    class Config <  Struct.new(:salt,:base_url,:app_id,:api_token,
+                               :unauthorised_path)
+      private_class_method :new
+
+      def self.base_url
+        @config.base_url
+      end
+      
+      def self.salt
+        @config.salt
+      end
+
+      def self.api_token
+        @config.api_token
+      end
+      
+      def self.unauthorised_path
+        @config.unauthorised_path
+      end
+
+      def self.app_id
+        @config.app_id
+      end
+
+      def self.init
+        config = new
+        yield(config)
+        config.base_url.gsub(/\/$/, "")      
+        @config = config
+      end
+    
+    end
+  end
+end

data/lib/driftrock-service/connector.rb

@@ -0,0 +1,49 @@
+require 'httparty'
+module Driftrock
+  module Service
+    module Connector
+      
+      def build_url_for_driftrock(url)
+        url = "/"+url if url !~ /^\/.*/
+        Driftrock::Service::Config.base_url+url
+      end
+
+      def post_to_api(url, user_id, company_id, data)
+        response = HTTParty.post(build_url_for_driftrock(url), :body => body_for(user_id, company_id, data))
+        puts "[MD => CALLING #{build_url_for_driftrock(url)} WITH:"
+        puts body_for(user_id, company_id, data)
+        puts "[MD] => RESPONSE IS:"
+        puts response
+        puts "========="
+        response
+      end
+      def get_from_api(url, user_id, company_id, data={})
+        response = HTTParty.get(build_url_for_driftrock(url), :body => body_for(user_id, company_id, data))
+        puts "[MD => CALLING #{build_url_for_driftrock(url)} WITH:"
+        puts body_for(user_id, company_id, data)
+        puts "[MD] => RESPONSE IS:"
+        puts response
+        puts "========="
+        response
+      end
+      
+      def put_to_api(url, user_id, company_id, data={})
+        HTTParty.put(build_url_for_driftrock(url), :body => body_for(user_id, company_id, data))
+      end
+
+
+      def body_for(user_id, company_id, data)
+        
+        data = {:company_id => company_id}.merge(data)
+        { :data => data, 
+          :auth => {
+            :session_id => user_id,
+            :app_id => Driftrock::Service::Config.app_id,
+            :api_token => Driftrock::Service::Config.api_token
+          } 
+        }
+      end
+      module_function :get_from_api, :post_to_api, :body_for, :build_url_for_driftrock
+    end
+  end
+end

data/lib/driftrock-service/errors/driftrock_error.rb

@@ -0,0 +1,17 @@
+module Driftrock
+  module Errors
+
+    class DriftrockError < StandardError
+
+      attr_reader :errors
+
+      def initialize(list_of_errors)
+        result = super()
+        @errors = list_of_errors
+        result
+      end
+
+    end
+
+  end
+end

data/lib/driftrock-service/version.rb

@@ -0,0 +1,5 @@
+module Driftrock
+  module Service
+    VERSION = "0.1.8"
+  end
+end

data/lib/driftrock-service.rb

@@ -0,0 +1,60 @@
+require "driftrock-service/version"
+require "driftrock-service/config"
+require "driftrock-service/connector"
+require "driftrock-service/api"
+require "driftrock-service/api/administrative"
+require "driftrock-service/api/data"
+require "driftrock-service/api/puller"
+require "driftrock-service/errors/driftrock_error"
+
+
+module Driftrock
+  module Service      
+    module ClassMethods
+      def act_as_driftrock_app
+        if respond_to?(:before_filter)
+          before_filter :authorise
+        end
+        include Driftrock::Service::Api::Data
+      end
+
+      def act_as_driftrock_administrator
+        include Driftrock::Service::Api::Administrative
+      end 
+
+      def act_as_driftrock_puller
+        include Driftrock::Service::Api::Puller
+      end 
+    end
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+
+    def authorise
+      return if session && session[:user_id] && session[:company_id]
+      timestamp = params[:timestamp]
+      company_id= params[:company_id]
+      token     = params[:token]
+
+      expected_token = token_for(timestamp, company_id)
+      puts "expected_token: #{expected_token}"
+
+      if token != expected_token
+        redirect_to Driftrock::Service::Config.unauthorised_path
+      else
+        session[:user_id] = params[:user_id]
+        session[:company_id] = params[:company_id]
+      end
+    end
+
+    def token_for(timestamp, company_id)
+      OpenSSL::Digest::SHA1.hexdigest( 
+        [timestamp,Driftrock::Service::Config.salt,company_id].join(":")
+      )
+    end
+
+
+  end
+end

data/spec/administrative_api_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe AdministrativeApiTest do
+  it "should be able to make a call to the api" do
+    #Assume for the sake of testing there's at least one app
+    AdministrativeApiTest.new.apps.count.should be > 0
+  end
+  
+end

data/spec/models/administrative_api_test.rb

@@ -0,0 +1,8 @@
+class AdministrativeApiTest
+  include Driftrock::Service::Api::Administrative
+
+  def test
+    apps 
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'driftrock-service'
+require File.join(File.dirname(__FILE__), *%w[models administrative_api_test.rb])
+
+Driftrock::Service::Config.init do |config|
+  config.base_url = "http://localhost:9393"
+  config.salt = "3kllki3weid9n3rljcw932oknc2ico23nlckno2i3f2on2o4ilknc2il3jp23mn"
+  config.api_token = "45asf42cwewfwf234/sfw34"
+  config.app_id = "23df434v34gdfnrnrt/regergw4"
+  config.unauthorised_path = "/unauthorised"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: driftrock-service
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+  prerelease: 
+platform: ruby
+authors:
+- Max
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for talking to the driftrock apu
+email:
+- max.dupenois@forward.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- driftrock-service.gemspec
+- lib/driftrock-service.rb
+- lib/driftrock-service/api.rb
+- lib/driftrock-service/api/administrative.rb
+- lib/driftrock-service/api/data.rb
+- lib/driftrock-service/api/puller.rb
+- lib/driftrock-service/config.rb
+- lib/driftrock-service/connector.rb
+- lib/driftrock-service/errors/driftrock_error.rb
+- lib/driftrock-service/version.rb
+- spec/administrative_api_spec.rb
+- spec/models/administrative_api_test.rb
+- spec/spec_helper.rb
+homepage: https://github.com/forward/driftrock-service
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Maintains the api endpoints and the calls to them with authorisation, etc.
+test_files:
+- spec/administrative_api_spec.rb
+- spec/models/administrative_api_test.rb
+- spec/spec_helper.rb