blueprint-api-rails 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6502d011050b9786945a3f1f925f51af9f3f96f3
+  data.tar.gz: 7f95f1e4053abdc6a68d8df469ae23e235fda945
+SHA512:
+  metadata.gz: 784268e1cdd598b43525d24924fd3cce843576a226b9e09e136f27768c6677eb721b20a97e535ef59ba9e97f9e177dc01cae3da7a6e96fa377bf136b4a0eb5ae
+  data.tar.gz: ec52444c33f3ef868f5b4df5be9e95ccda3c2bddef8e19e9458e796b5131cd3a5ca2cb9c97a6233fe75ecadac5de54a67414cf1784061b512ea40f3939cf699c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Ignore IDE-specific files
+.idea

data/.idea/.name

@@ -0,0 +1 @@
+blueprint-api-rails

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build blueprint-api-rails-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install blueprint-api-rails-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v0.1.0 and build and push blueprint-api-rails-0.1.0.gem to Rubygems" fullCmd="release" taksId="release" /></RakeGroup></Settings>

data/.idea/blueprint-api-rails.iml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="gem" name="Ruby Gem">
+      <configuration>
+        <option name="GEM_APP_ROOT_PATH" value="$MODULE_DIR$" />
+        <option name="GEM_APP_TEST_PATH" value="" />
+        <option name="GEM_APP_LIB_PATH" value="$MODULE_DIR$/lib" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="ModuleRunConfigurationManager">
+    <configuration default="false" name="rails" type="RubyRunConfigurationType" factoryName="Ruby" temporary="true">
+      <module name="blueprint-api-rails" />
+      <RUBY_RUN_CONFIG NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
+      <RUBY_RUN_CONFIG NAME="WORK DIR" VALUE="$MODULE_DIR$/lib/blueprint/api" />
+      <RUBY_RUN_CONFIG NAME="SHOULD_USE_SDK" VALUE="false" />
+      <RUBY_RUN_CONFIG NAME="ALTERN_SDK_NAME" VALUE="" />
+      <RUBY_RUN_CONFIG NAME="myPassParentEnvs" VALUE="true" />
+      <envs />
+      <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="false" />
+      <EXTENSION ID="JRubyRunConfigurationExtension" NailgunExecEnabled="false" />
+      <EXTENSION ID="RubyCoverageRunConfigurationExtension" enabled="false" sample_coverage="true" track_test_folders="true" runner="rcov">
+        <COVERAGE_PATTERN ENABLED="true">
+          <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
+        </COVERAGE_PATTERN>
+      </EXTENSION>
+      <RUBY_RUN_CONFIG NAME="SCRIPT_PATH" VALUE="$MODULE_DIR$/lib/blueprint/api/rails.rb" />
+      <RUBY_RUN_CONFIG NAME="SCRIPT_ARGS" VALUE="" />
+      <method />
+    </configuration>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.bundle" />
+      <excludeFolder url="file://$MODULE_DIR$/vendor/bundle" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.3.2, rbenv: 2.1.1) [gem]" level="application" />
+  </component>
+</module>

data/.idea/encodings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding">
+    <file url="PROJECT" charset="UTF-8" />
+  </component>
+</project>

data/.idea/misc.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectLevelVcsManager" settingsEditedManually="false">
+    <OptionsSetting value="true" id="Add" />
+    <OptionsSetting value="true" id="Remove" />
+    <OptionsSetting value="true" id="Checkout" />
+    <OptionsSetting value="true" id="Update" />
+    <OptionsSetting value="true" id="Status" />
+    <OptionsSetting value="true" id="Edit" />
+    <ConfirmationsSetting value="0" id="Add" />
+    <ConfirmationsSetting value="0" id="Remove" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 2.1.1" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/blueprint-api-rails.iml" filepath="$PROJECT_DIR$/.idea/blueprint-api-rails.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# Blueprint::Api::Rails
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/blueprint/api/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blueprint-api-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blueprint-api-rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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/[USERNAME]/blueprint-api-rails.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blueprint/api/rails"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/blueprint-api-rails.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blueprint/api/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blueprint-api-rails'
+  spec.version       = Blueprint::Api::Rails::VERSION
+  spec.authors       = ['benjii']
+  spec.email         = ['ben.deany@gmail.com']
+
+  spec.summary       = %q{Rails client for the Anaxim Blueprint API}
+  spec.homepage      = 'http://anaxim.io'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.9.2'
+end

data/lib/blueprint/api/rails/version.rb

@@ -0,0 +1,7 @@
+module Blueprint
+  module Api
+    module Rails
+      VERSION = '0.1.2'
+    end
+  end
+end

data/lib/blueprint/api/rails.rb

@@ -0,0 +1,221 @@
+require 'blueprint/api/rails/version'
+require 'faraday'
+
+module Blueprint
+
+  BLUEPRINT_SERVER = ENV['BLUEPRINT_SERVER'] || 'http://anaxim.io'
+  BLUEPRINT_URL_CONTEXT = '/api/v1/events'
+
+
+  STRUCTURE_NEW = 'start'
+  MESSAGE = 'message'
+  CLASSIFIER_NEW = 'classifier-new'
+
+  # allow users to set the API key
+  def self.set_api_key api_key
+    @api_key = api_key
+  end
+
+  # call this to create a structure and get a design context
+  def self.start(structure_id, name)
+    DesignContext.new(@api_key, structure_id).send STRUCTURE_NEW, { :name => name }
+  end
+
+
+  class DesignContext
+
+    def initialize(api_key, structure_id)
+      @api_key = api_key
+      @structure_id = structure_id
+      @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
+
+      # initialise faraday
+      @conn = Faraday.new(:url => BLUEPRINT_SERVER) do |faraday|
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    # creates a design context between source and target
+    def link(source, target)
+      LinkDesignContext.new(@api_key, @structure_id, source, target)
+    end
+
+    # creates a new message classifier
+    def classifier(from, condition, to)
+      self.send CLASSIFIER_NEW,
+                {
+                    :from => from,
+                    :condition => condition,
+                    :to => to
+                }
+      nil
+    end
+
+    # logs a message between two nodes in the structure
+    def log(source, target, type, message = { }, extras = { })
+      self.send MESSAGE,
+                {
+                    :source => source,
+                    :target => target
+                },
+                {
+                    :type => type,
+                    :payload => {
+                        :message => message,       # the message that was sent
+                        :extras => extras          # extra details about the message that can aid classification
+                }
+          }
+      nil
+    end
+
+    # utility method for sending JSON payloads to the Anaxim servers - should never be called directly
+    def send(event_type, properties = { }, message = { })
+
+      # construct the base payload
+      payload = {
+          :header => {
+              :structure_id => @structure_id,
+              :properties => properties,
+              :branch => {
+                  :name => @branch || 'master'
+              },
+              :eventType => event_type
+          }
+      }
+
+      # merge (append) the properties hash onto the payload (properties vary per event type)
+      payload.merge! message
+
+      @conn.post do |req|
+        req.url BLUEPRINT_URL_CONTEXT
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['X-Api-Key'] = @api_key
+        req.body = payload.to_json
+      end
+
+      self
+    end
+
+  end
+
+  class LinkDesignContext < DesignContext
+
+    def initialize(api_key, structure_id, source, target)
+      @api_key = api_key
+      @structure_id = structure_id
+      @source = source
+      @target = target
+      @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
+
+      # initialise faraday
+      @conn = Faraday.new(:url => BLUEPRINT_SERVER) do |faraday|
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    # logs a message between two nodes in the structure
+    def log(type, message = { }, extras = { })
+      self.send MESSAGE,
+                {
+                    :source => @source,
+                    :target => @target
+
+                },
+                {
+                    :type => type,
+                    :payload => {
+                        :message => message,       # the message that was sent
+                        :extras => extras          # extra details about the message that can aid classification
+                    }
+                }
+      nil
+    end
+
+  end
+
+end
+
+
+# # activity diagram event types
+# ACTIVITY_START = 'activity-start'
+# ACTIVITY_ACTION = 'activity-action'
+# ACTIVITY_DECISION = 'activity-decision'
+# ACTIVITY_DECISION_OUTCOME = 'activity-decision-outcome'
+# ACTIVITY_OUTCOME = 'activity-outcome'
+# ACTIVITY_END = 'activity-end'
+
+# COMPONENTS_START = 'components-start'
+# COMPONENTS_NEW = 'components-new'
+# COMPONENTS_LINK = 'components-link'
+#
+# MESSAGE = 'message'
+
+
+# # use this to create a new activity - returns a design context, which can be used for subsequent calls
+# def self.start_activity(diagram, name, start_state)
+#   DesignContext.new(@api_key, diagram).send ACTIVITY_START, { :name => name, :state => start_state }
+# end
+
+# # use this to create a new set of system components - returns a design context, which can be used for subsequent calls
+# def self.declare_system(diagram, name)
+#   DesignContext.new(@api_key, diagram).send COMPONENTS_START, { :name => name }
+# end
+
+# def self.log_message(diagram, identifier, type, message = { })
+#   DesignContext.new(@api_key, diagram, identifier, nil)
+#       .send MESSAGE, { :type => type, :message => message }
+#   nil
+# end
+
+
+
+# # -----------------------------------------------------------------------
+# # activity diagram API calls
+#
+# def decide(identifier, condition)
+#   # returns a new design context that represents the decision
+#   DesignContext.new(@api_key, @diagram, identifier, self)
+#                .send ACTIVITY_DECISION, { :condition => condition }
+# end
+#
+# def positive(*args)
+#   if args.length == 1
+#     outcome 'positive', args[0]
+#   elsif args.length == 2
+#     decision_outcome args[0], 'positive', args[1]
+#   end
+# end
+#
+# def negative(*args)
+#   if args.length == 1
+#     outcome 'negative', args[0]
+#   elsif args.length == 2
+#     decision_outcome args[0], 'negative', args[1]
+#   end
+# end
+#
+# def decision_outcome(identifier, outcome, condition)
+#   # returns a new design context that represents the outcome
+#   DesignContext.new(@api_key, @diagram, identifier, self)
+#                .send ACTIVITY_DECISION_OUTCOME, { :outcome => outcome, :condition => condition }
+# end
+#
+# def outcome(outcome, action)
+#   # returns a new design context that represents the outcome
+#   DesignContext.new(@api_key, @diagram, nil, self)
+#                .send ACTIVITY_OUTCOME, { :outcome => outcome, :action => action }
+# end
+#
+# def action(identifier, action)
+#   # returns a new design context that represents the action
+#   DesignContext.new(@api_key, @diagram, identifier, self)
+#                .send ACTIVITY_ACTION, { :action => action }
+# end
+#
+# def end(state)
+#   # returns a new design context that represents the end of the activity
+#   DesignContext.new(@api_key, @diagram, nil, self)
+#                .send ACTIVITY_END, { :state => state }
+# end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: blueprint-api-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- benjii
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: 
+email:
+- ben.deany@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/.rakeTasks"
+- ".idea/blueprint-api-rails.iml"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blueprint-api-rails.gemspec
+- lib/blueprint/api/rails.rb
+- lib/blueprint/api/rails/version.rb
+homepage: http://anaxim.io
+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.8
+signing_key: 
+specification_version: 4
+summary: Rails client for the Anaxim Blueprint API
+test_files: []