statwing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b5c31fa4a0dbcff7bdd36ab85f569b50d367613
+  data.tar.gz: 39fbac854218d620ba482213c00a1685663c61b2
+SHA512:
+  metadata.gz: d1f0324e52b9550520a0323f99294dbbe81f4f5d0d9a5bef4f90d6a6a1047b73b9dffc658162d7aeac82eb66771813b8589f0378d95028affef03dddecd761e8
+  data.tar.gz: afe65a6f242af64e99982094244344101e5c35e2b27976cc0efca1ea50eaa89dec4e3fed84c28382c25d5e435f60eb669f82623a51347eae73ae539cf94f6e23

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Matthew Dodds
+
+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,71 @@
+# Statwing
+
+Ruby wrapper for the Statwing Api. This is accomplished using the [HER](https://github.com/remiprev/her) Object Relational Mapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'statwing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statwing
+
+## Configuration
+
+```ruby
+Statwing.configure do |config|
+	config.api_key = 'your_api_key'
+end
+```
+
+## Usage
+
+Creating a User and associating a new dataset:
+
+```ruby
+@user = Statwing::User.create(partner_user_id: 'identifier')
+=> #<Statwing::User(users/usr_e9gAmn3WuEeDKjDwELRisB2lNYvAJMZa) partner_user_identity="identifier" id="usr_e9gAmn3WuEeDKjDwELRisB2lNYvAJMZa">
+
+@dataset = Statwing::Dataset.create(name: "real-estate-transactions-sample.csv",fileurl: 'https://gist.githubusercontent.com/MatthewRDodds/5bf959ec16b67fd7c421/raw/52089a06e2fc9f8b74b85f49922f792610f3b6ae/real-estate-transactions-sample.csv', users: {action: 'add', data: [{ object: 'user_id', data: "usr_e9gAmn3WuEeDKjDwELRisB2lNYvAJMZa" }]})
+=> #<Statwing::Dataset:0x3fff3d1023c8>
+
+@user.datasets
+=> [#<Statwing::Dataset:0x3fff3d5fe0d4>]
+Statwing::Dataset.create(fileurl: 'https://gist.github.com/sandbox/6983768/raw/81e00eff263d6ac9fdedbe28de7d33dc8e850f2f/statwing.csv',name: 'statwing.csv',shared: 'restricted',action: 'add',users: [{object: 'user_id', data: 'usr_cNUWGust9V9xPFdXg6Ggv5rUnO7b3mUa'}])
+
+@dataset.attributes
+=> {"name"=>"real-estate-transactions-sample.csv",
+"filesize"=>113183,
+"state"=>"processed",
+"shared"=>"restricted",
+"created_at"=>"2015-04-08T15:07:11Z",
+"parse_settings"=>{"parser"=>"csv"},
+"url_base"=>
+"https://export.statwing.com/p0/datasets/dat_ufz8Ycgo0NiWSjICDYNCfzszXgqUeRrQ",
+"users"=>nil}
+
+@user.datasets.first.id
+=> "dat_ufz8Ycgo0NiWSjICDYNCfzszXgqUeRrQ"
+
+Statwing::Dataset.find('dat_ufz8Ycgo0NiWSjICDYNCfzszXgqUeRrQ').users
+=> [{"id"=>"usr_e9gAmn3WuEeDKjDwELRisB2lNYvAJMZa",
+  "partner_user_id"=>"identifier",
+  "url"=>
+   "https://export.statwing.com/p0/datasets/dat_ufz8Ycgo0NiWSjICDYNCfzszXgqUeRrQ/users/usr_e9gAmn3WuEeDKjDwELRisB2lNYvAJMZa"}]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/statwing/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/statwing.rb

@@ -0,0 +1,17 @@
+require 'statwing/version'
+
+require 'active_support'
+require 'active_support/core_ext/string'
+
+require 'json'
+require 'her'
+
+require 'statwing/middleware/authentication'
+require 'statwing/middleware/parser'
+require 'statwing/configuration'
+require 'statwing/api'
+
+require 'statwing/models/shared/model'
+require 'statwing/models/shared/creatable'
+require 'statwing/models/dataset'
+require 'statwing/models/user'

data/lib/statwing/api.rb

@@ -0,0 +1,8 @@
+ssl_options = { verify: true, verify_mode: OpenSSL::SSL::VERIFY_NONE }
+
+Her::API.setup url: Statwing::API_URL, ssl: ssl_options do |c|
+	c.use Statwing::Authentication
+	c.use Faraday::Request::UrlEncoded
+  c.use Statwing::Parser
+  c.use Faraday::Adapter::NetHttp
+end

data/lib/statwing/configuration.rb

@@ -0,0 +1,23 @@
+module Statwing
+	API_URL = 'https://www.statwing.com/api/p0/'
+
+	class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = ''
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+	  def configuration
+	    @configuration ||= Configuration.new
+	  end
+
+	  def configure
+	    yield(configuration)
+	  end
+  end
+end

data/lib/statwing/middleware/authentication.rb

@@ -0,0 +1,10 @@
+module Statwing
+	class Authentication < Faraday::Middleware
+	  def call(env)
+	    key = Base64.encode64(Statwing.configuration.api_key).gsub!("\n", '')
+	    env[:request_headers]["Authorization"] = "Basic #{key}:"
+
+	    @app.call(env)
+	  end
+	end
+end

data/lib/statwing/middleware/parser.rb

@@ -0,0 +1,16 @@
+module Statwing
+	class Parser < Faraday::Response::Middleware
+	  def on_complete(env)
+	    json = JSON.parse(env[:body], :symbolize_names => true)
+	    error = json.delete(:error) || {}
+
+	    # Raise error when request returns an error
+	    if error.present?
+	    	fail "#{error[:type].classify}: #{error[:message]}"
+	    end
+
+	    metadata = json.delete(:metadata) || []
+	    env[:body] = { :data => json, :errors => error, :metadata => metadata }
+	  end
+	end
+end

data/lib/statwing/models/dataset.rb

@@ -0,0 +1,7 @@
+module Statwing
+	class Dataset
+		include Model
+		include Creatable
+	end
+end
+

data/lib/statwing/models/shared/creatable.rb

@@ -0,0 +1,19 @@
+module Statwing
+	module Creatable
+		extend ActiveSupport::Concern
+
+	  module ClassMethods
+	  	def element_name
+				@element_name ||= model_name.element.to_sym
+			end
+
+			def root
+				@root ||= root_element.to_s
+			end
+
+			def create(attrs)
+				new post_raw(root, Hash[element_name, attrs])[:parsed_data][:data]
+			end
+	  end
+	end
+end

data/lib/statwing/models/shared/model.rb

@@ -0,0 +1,12 @@
+module Statwing
+	module Model
+		extend ActiveSupport::Concern
+
+	  included do
+	    include Her::Model
+
+			include_root_in_json true
+			parse_root_in_json true, format: :json_api
+	  end
+	end
+end

data/lib/statwing/models/user.rb

@@ -0,0 +1,8 @@
+module Statwing
+	class User
+		include Model
+		include Creatable
+
+		has_many :datasets
+	end
+end

data/lib/statwing/version.rb

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

data/statwing.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'statwing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'statwing'
+  spec.version       = Statwing::VERSION
+  spec.authors       = ['Matthew Dodds']
+  spec.email         = ['matthewrusselldodds@gmail.com']
+  spec.summary       = %q{Ruby wrapper for Statwing Api}
+  spec.description   = 'Provides easy access to the statwing api for Ruby applications'
+  spec.homepage      = 'http://github.com/MatthewRDodds/statwing'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'her', '~> 0.7'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: statwing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Dodds
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Provides easy access to the statwing api for Ruby applications
+email:
+- matthewrusselldodds@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/statwing.rb
+- lib/statwing/api.rb
+- lib/statwing/configuration.rb
+- lib/statwing/middleware/authentication.rb
+- lib/statwing/middleware/parser.rb
+- lib/statwing/models/dataset.rb
+- lib/statwing/models/shared/creatable.rb
+- lib/statwing/models/shared/model.rb
+- lib/statwing/models/user.rb
+- lib/statwing/version.rb
+- statwing.gemspec
+homepage: http://github.com/MatthewRDodds/statwing
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Statwing Api
+test_files: []