framed_uploader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a702bf11763ea273e84d175266a9d89216ba1cb8
+  data.tar.gz: 2881546305989da89820a2a31b821dae7912ef34
+SHA512:
+  metadata.gz: b7ae8d65b1120a3d4b816696b2ea86f3915dc4e577effa8994031c33b268b5ff3a1881e3f2784ecb6458249b2043461233cf1e9d444207b3e70392b4467766b7
+  data.tar.gz: f97db4922009c66a03e8b4585703eea9a8dcd966e5827b49a5b5c32c2fb0e9add96cc57ced21333979381f327508edc3e81676efd8d126fe80c111f62f3f6444

data/.gitignore

@@ -0,0 +1,50 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.ltate
+/.bundle
+/vendor/bundle/
+/vendor/ruby/
+db/*.sqlite3
+/db/*.sqlite3-journal
+/log/*
+/tmp/*
+**.war
+*.rbc
+*.sassc
+.rspec
+.redcar/
+.sass-cache
+/config/config.yml
+/config/database.yml
+/config/application.yml
+/config/secrets.yml
+/coverage.data
+/db/*.javadb/
+/db/*.sqlite3
+/spec/tmp/*
+/cache
+/capybara*
+/capybara-*.html
+/gems
+/specifications
+rerun.txt
+.zeus.sock
+tags
+gems.tags
+**.orig
+.DS_Store
+/nbproject/
+.idea
+/*.tmproj
+**.swp

data/.ruby-gemset

@@ -0,0 +1 @@
+framed_uploader

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,65 @@
+## Framed Uploader
+
+This is the Ruby client library for uploading custom data to the [Framed](http://framed.io/) data platform.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'framed_uploader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install framed_uploader
+
+## Uploading user information
+
+You can upload custom information about your users (ex: a dump of a users SQL table), which will be integrated
+directly into Framed's machine learning models for making more accurate predictions.
+
+The uploader can be used as a library from your application code, or with the bundled CLI runner.
+You will need your API key, which you can get from your Framed dashboard.
+
+As a library:
+
+Using the CLI runner script:
+
+```ruby
+bundle exec framed-upload API_KEY FILENAME
+```
+
+Or as a library:
+
+```ruby
+require 'framed_uploader'
+
+uploader = FramedUploader::Uploader.new("my-api-key")
+uploader.upload("/path/to/users.csv")
+```
+
+Using the CLI:
+
+Usage: `bundle exec framed-upload API_KEY [FILENAMES ...]`
+
+Example:
+
+```
+bundle exec framed-upload abcd1234 users.csv
+```
+
+Please note that user data **must** be in a CSV-formatted file named `users.csv`, and there **must** be an
+`id` column containing a value that uniquely identifies each user (ex: the primary key on a `users` table).
+For example:
+
+```
+id,name,email
+3,"John Smith","john@example.com"
+18,"Jane Doe',"jane@example.com"
+88,"Fred Flinstone","fred@example.com"
+```

data/Rakefile

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

data/bin/framed-upload

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'framed_uploader'
+
+api_key, *filenames = ARGV
+
+USAGE  = "Usage: framed-upload API_KEY [FILENAME ...]"
+
+if api_key.nil? || filenames.empty?
+  puts USAGE
+  exit 1
+end
+
+uploader = FramedUploader::Uploader.new(api_key)
+uploader.upload(*filenames)

data/framed_uploader.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'framed_uploader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "framed_uploader"
+  spec.version       = FramedUploader::VERSION
+  spec.authors       = ["Andrew Berls"]
+  spec.email         = ["andrew.berls@gmail.com"]
+  spec.summary       = %q{Framed user data uploader}
+  spec.description   = %q{Framed user data uploader}
+  spec.homepage      = ""
+  spec.license       = ""
+
+  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"]
+
+  spec.add_dependency 'aws-sdk', '~> 2'
+  spec.add_dependency 'addressable', '~> 2.3.5'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/framed_uploader/uploader.rb

@@ -0,0 +1,83 @@
+require 'addressable/template'
+require 'net/http'
+require 'json'
+require 'aws-sdk'
+
+module FramedUploader
+  class CredentialsError < StandardError; end
+  class FileNotFoundError < StandardError; end
+
+  class Uploader
+    CREDS_ENDPOINT = 'https://app.framed.io/uploads/1.0/credentials'.freeze
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def upload(*filenames)
+      validate_files!(filenames)
+
+      creds_response = get_credentials!
+      tmpl = Addressable::Template.new(creds_response.fetch(:template))
+      bucket = creds_response.fetch(:bucket)
+      company_id = creds_response.fetch(:company_id)
+      batch_timestamp = Time.now.to_i
+      s3 = s3_client(creds_response)
+
+      filenames.each do |filename|
+        s3_key = tmpl.expand({"company_id" => company_id,
+                              "timestamp" => batch_timestamp,
+                              "filename" => filename}).path
+
+        File.open(filename, 'rb') do |body|
+          s3.put_object(bucket: bucket, key: s3_key, body: body)
+        end
+      end
+    end
+
+    private
+
+    def validate_files!(filenames)
+      filenames.each do |filename|
+        path = File.expand_path(filename)
+        if !File.exists?(path)
+          raise FileNotFoundError.new("#{path} doesn't exist")
+        end
+      end
+    end
+
+    # options - Hash of
+    #   :region
+    #   :access_key
+    #   :secret_key
+    #   :session_token
+    def s3_client(options)
+      region = options.fetch(:region)
+      access_key = options.fetch(:access_key)
+      secret_key = options.fetch(:secret_key)
+      session_token = options.fetch(:session_token)
+
+      s3 = Aws::S3::Client.new(
+        region: region,
+        credentials: Aws::Credentials.new(access_key, secret_key, session_token)
+      )
+    end
+
+    # Retrieve S3 credentials and information from the Framed API
+    def get_credentials!
+      uri = URI(CREDS_ENDPOINT)
+      req = Net::HTTP::Post.new(uri.request_uri)
+      req.basic_auth(@api_key, "")
+      resp = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |https|
+        https.request(req)
+      end
+
+      if resp.is_a?(Net::HTTPSuccess)
+        JSON.parse(resp.body, {:symbolize_names => true})
+      else
+        raise CredentialsError.new("Error retrieving credentials; please try again shortly (#{resp.body})")
+      end
+    end
+
+  end
+end

data/lib/framed_uploader/version.rb

@@ -0,0 +1,3 @@
+module FramedUploader
+  VERSION = "0.0.1"
+end

data/lib/framed_uploader.rb

@@ -0,0 +1,5 @@
+require "framed_uploader/version"
+require "framed_uploader/uploader"
+
+module FramedUploader
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: framed_uploader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Berls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Framed user data uploader
+email:
+- andrew.berls@gmail.com
+executables:
+- framed-upload
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/framed-upload
+- framed_uploader.gemspec
+- lib/framed_uploader.rb
+- lib/framed_uploader/uploader.rb
+- lib/framed_uploader/version.rb
+homepage: ''
+licenses:
+- ''
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Framed user data uploader
+test_files: []