castle-keep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec4cf3c15dd8218d822f0a8635de41fe99006bae
+  data.tar.gz: 068c655b6981ab13c5cba2d7c620cbecf899fdb7
+SHA512:
+  metadata.gz: a3ec81aa9817fe03b21db498ebe99f52c2121eeceb46279ae8b31bd7fc67089fd8e59e492a5d896268258cca5a5297bb3be9713a91e2c9381f7404b0a2e2d44f
+  data.tar.gz: 99457f15fe16662ba502dea27029da44645b11155dddc25e58551a5562f6609c42363332dc3eddb03a7f617d89ec36a228177a6eabc33ffd0eda25f8bcbbb286

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,58 @@
+# Castle::Keep
+
+This is a minimal implementation of the Castle.io Server-Side API.
+This gem exists because the official [castle-rb](https://github.com/castle/castle-ruby) gem has quite a few external dependencies that can cause compatibility issues.
+
+The code for the initial version of this gem was taken directly from [carlhoerberg](https://github.com/carlhoerberg)'s [gist](https://gist.github.com/carlhoerberg/d5537dd3990c7e3042942f587801b9cd)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'castle-keep'
+```
+
+Load and configure the library with your Castle API secret in an initializer or similar.
+
+```ruby
+Castle.api_secret = 'YOUR_API_SECRET'
+```
+
+## Usage
+
+A new instance of `Castle::Keep` should be created for each request that comes through your stack.
+I recommend using a per-request global storage system like [request_store](https://github.com/steveklabnik/request_store)
+
+Rails Example:
+```ruby
+class ApplicationController < ActionController::Base
+  before_filter :_set_castle
+
+  private
+  def _set_castle
+    RequestStore.store[:castle] = Castle::Keep.create_context(request)
+  end
+end
+```
+
+Once the helper is loaded you can then do:
+```ruby
+begin
+  RequestStore.store[:castle].track(
+    name: '$login.succeeded',
+    user_id: user.id)
+rescue Castle::Error => e
+  puts e.message
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thekidcoder/castle-keep.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "castle/keep"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/castle-keep.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'castle/keep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "castle-keep"
+  spec.version       = Castle::VERSION
+  spec.authors       = ["Christopher Ostrowski"]
+  spec.email         = ["chris.ostrowski@gmail.com"]
+
+  spec.summary       = %q{Simplified version of the castle-rb gem. Minimized dependencies for maximum compatibility.}
+  spec.description   = %q{Simplified version of the castle-rb gem. Minimized dependencies for maximum compatibility.}
+  spec.homepage      = "https://github.com/TheKidCoder/Castle-Keep"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/castle/keep.rb

@@ -0,0 +1,104 @@
+require 'castle/keep/version'
+require 'net/https'
+require 'json'
+
+module Castle
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  class Keep
+    def self.create_context(request)
+      Castle::Keep.new(request.cookies['__cid'], request.ip, request.env.keys.grep(/^HTTP_/).map do |header|
+        name = header.gsub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
+        unless name == "Cookie"
+          { name => request.env[header] }
+        end
+      end.compact.inject(:merge))
+    end
+
+    def initialize(cookie_id, ip, headers)
+      @http = Net::HTTP.new "api.castle.io", 443
+      @http.use_ssl = true
+      @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      @headers = {
+        "Content-Type" => "application/json",
+        "X-Castle-Cookie-Id" => cookie_id,
+        "X-Castle-Ip" => ip,
+        "X-Castle-Headers" => headers.to_json,
+      }
+    end
+
+    # Available events:
+    # $login.succeeded: Record when a user attempts to log in.
+    # $login.failed: Record when a user login failed.
+    # $logout.succeeded: Record when a user logs out.
+    # $registration.succeeded: Capture account creation, both when a user signs up as well as when created manually by an administrator.
+    # $registration.failed: Record when an account failed to be created.
+    # $email_change.requested: An attempt was made to change a user’s email.
+    # $email_change.succeeded: The user completed all of the steps in the email address change process and the email was successfully changed.
+    # $email_change.failed: Use to record when a user failed to change their email address.
+    # $password_reset.requested: An attempt was made to reset a user’s password.
+    # $password_reset.succeeded: The user completed all of the steps in the password reset process and the password was successfully reset. Password resets do not required knowledge of the current password.
+    # $password_reset.failed: Use to record when a user failed to reset their password.
+    # $password_change.succeeded: Use to record when a user changed their password. This event is only logged when users change their own password.
+    # $password_change.failed: Use to record when a user failed to change their password.
+    def track(event_name, user_id: nil, details: nil)
+      if user_id.nil? && details.nil?
+        fail ArgumentError, "Missing both user_id and details"
+      end
+
+      req = Net::HTTP::Post.new("/v1/events", @headers)
+      req.basic_auth("", Castle.api_key)
+      req.body = { name: event_name, user_id: user_id, details: details }.to_json
+      response = @http.request(req)
+      unless response.code.to_i == 204
+        fail Error, "Response code: #{response.code}\nResponse body: #{response.body}"
+      end
+    end
+
+    def events(user_id, page: 1, page_size: 200)
+      req = Net::HTTP::Get.new("/v1/events?query=user_id:#{user_id}&page=#{page}&page_size=#{page_size}", @headers)
+      req.basic_auth("", Castle.api_key)
+      response = @http.request(req)
+      unless response.code.to_i == 200
+        fail Error, "Response code: #{response.code}\nResponse body: #{response.body}"
+      end
+    end
+
+    def create_auth(user_id)
+      req = Net::HTTP::Post.new("/v1/authentications", @headers)
+      req.basic_auth("", Castle.api_key)
+      req.body = { user_id: user_id }.to_json
+      response = @http.request(req)
+      unless response.code.to_i == 201
+        fail Error, "Response code: #{response.code}\nResponse body: #{response.body}"
+      end
+      JSON.parse response.body
+    end
+
+    def approve_auth(auth_id)
+      req = Net::HTTP::Post.new("/v1/authentications/#{auth_id}/approve", @headers)
+      req.basic_auth("", Castle.api_key)
+      response = @http.request(req)
+      unless response.code.to_i == 204
+        fail Error, "Response code: #{response.code}\nResponse body: #{response.body}"
+      end
+    end
+
+    def deny_auth(auth_id)
+      req = Net::HTTP::Post.new("/v1/authentications/#{auth_id}/deny", @headers)
+      req.basic_auth("", Castle.api_key)
+      response = @http.request(req)
+      unless response.code.to_i == 204
+        fail Error, "Response code: #{response.code}\nResponse body: #{response.body}"
+      end
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/castle/keep/version.rb

@@ -0,0 +1,3 @@
+module Castle
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: castle-keep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Ostrowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simplified version of the castle-rb gem. Minimized dependencies for maximum
+  compatibility.
+email:
+- chris.ostrowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- castle-keep.gemspec
+- lib/castle/keep.rb
+- lib/castle/keep/version.rb
+homepage: https://github.com/TheKidCoder/Castle-Keep
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simplified version of the castle-rb gem. Minimized dependencies for maximum
+  compatibility.
+test_files: []