streaker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bc2a4a60a0faa7cc2b4a9d4c9dd926a5bbed55f
+  data.tar.gz: 666da415df2bf8e6111dad1af75cc1a78239d477
+SHA512:
+  metadata.gz: 384896b543a2460b39c15fadef23d5144bc29c5a3c57e15cb60710296f5235c96bc6395fb91c1ac093e4144a93500fd016d05ea3574542b16023e949decbf0e6
+  data.tar.gz: 8dd14b39543a428545249b893d268aef075937ac6ffd84486f685fce60d2473d72f1fd24e50eaccf28f4c92fedda9cf9e04a1cbdde8c6d126ced205f6d8abd4c

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# custom credentials for specs and local console
+credentials.rb

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2017-12-11
+
+First release! :tada:

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sunny@sunfox.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in streaker.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 KissKissBankBank
+
+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,129 @@
+# Streaker [![CircleCI](https://circleci.com/gh/KissKissBankBank/streaker.svg?style=svg)](https://circleci.com/gh/KissKissBankBank/streaker)
+
+Ruby gem to access Streak's API.
+
+![Streaker on Ninja Warrior](https://media.giphy.com/media/LMfZEPTKKRgJy/giphy.gif)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'streaker'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install streaker
+```
+
+## Usage
+
+Create a box:
+
+```rb
+box = Streaker::Box.create(
+  name: 'Some box name',
+  stage: :my_stage,
+  my_field: 'Some field value',
+  …
+)
+box.key # => your new box's key
+```
+
+Update a box:
+
+```rb
+box = Streaker::Box.new('a_box_key')
+box.update(
+  my_field: 'A new field value',
+  …
+)
+```
+
+## Configuration
+
+Configure Streaker:
+
+```rb
+Streaker.configure do |config|
+  # To find your API key, check out http://www.streak.com/api/#apikey
+  config.api_key = 'YOUR_API_KEY_HERE'
+
+  # Provide an identifier for the pipeline(s) you want to access.
+  # You can find the pipeline keys keys by configuring your api key, then typing
+  # inside a console:
+  #     > Streak::Pipeline.all.map { |p| [p.key, p.name] }.to_h
+  config.pipeline_keys = {
+    default: 'YOUR_PIPELINE_KEY_HERE',
+  }
+
+  # Provide an identifier for each "Stage" your boxes can go through.
+  # You can find the stage keys by configuring a pipeline key, then typing
+  # inside a console:
+  #
+  #     > pipeline_key = Streaker.configuration.pipeline_keys.values.first
+  #     > stages = Streak::Stage.all(pipeline_key)
+  #     > stages = stages.instance_variable_get('@values')
+  #     > values = stages.map { |value| value.instance_variable_get('@values') }
+  #     > values.map { |value| [value[:key].to_i, value[:name]] }.to_h
+  config.stage_keys = {
+    my_stage: 1042,
+  }
+
+  # Provide an identifier for each custom field your boxes can have.
+  # You can find all the field keys by configuring a pipeline key, then typing
+  # inside a console:
+  #
+  #     $ bin/console
+  #     > pipeline_key = Streaker.configuration.pipeline_keys.values.first
+  #     > box = Streak::Box.all(pipeline_key).first ; nil
+  #     > Streak::FieldValue.all(box.key)
+  config.field_keys = {
+    my_field: 1043,
+  }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, create a `credentials.rb` file with:
+
+```rb
+Streaker.configure do |config|
+  # To find your API key, check out http://www.streak.com/api/#apikey
+  config.api_key = 'YOUR_API_KEY_HERE'
+end
+```
+
+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/KissKissBankBank/streaker. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code
+of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Streaker project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/[USERNAME]/streaker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# Bundler
+require 'bundler/gem_tasks'
+
+# RSpec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# RuboCop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'streaker'
+
+# Load custom credentials
+
+credentials_file = "#{__dir__}/../credentials.rb"
+load credentials_file if File.exist?(credentials_file)
+
+# Setup console
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/streaker/box.rb

@@ -0,0 +1,94 @@
+module Streaker
+  # Represents a Streak Box through the API.
+  class Box
+    class Error < RuntimeError
+    end
+
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    # Update data for a box:
+    #     box = Box.new('someboxkey')
+    #     box.update(
+    #       name: 'Some box name',
+    #       stage: :some_stage,
+    #       some_field_key: 'Some field value',
+    #       …
+    #     )
+    #
+    # You can also give a `stage: :stage` or
+    def update(attributes)
+      verify_if_box_exists
+
+      attributes.each do |attr, value|
+        update_attribute(attr, value)
+      end
+
+      true
+    end
+
+    # Create a Streak box:
+    #     box = Box.create(
+    #       pipeline: :some_pipeline_name,
+    #       name: 'Some box name',
+    #       stage: :some_stage,
+    #       some_field_key: 'Some field value',
+    #       …
+    #     )
+    def self.create(name:, pipeline: :default, **attributes)
+      api_result = Streak::Box.create(pipeline_key(pipeline), name: name)
+      box = new(api_result.key)
+      box.update(attributes)
+      box
+    end
+
+    def self.pipeline_key(pipeline)
+      Streaker.configuration.pipeline_keys.fetch(pipeline)
+    rescue KeyError
+      raise Error,
+            "No such pipeline #{pipeline.inspect} in the configuration"
+    end
+
+    private_class_method :pipeline_key
+
+    private
+
+    def verify_if_box_exists
+      Streak::Box.find(key)
+    rescue Streak::InvalidRequestError => e
+      if /Entity not found with key/ =~ e.message
+        raise Streaker::BoxNotFoundError, "Entity not found with key #{key}"
+      else
+        raise e
+      end
+    end
+
+    def stage_key(stage)
+      Streaker.configuration.stage_keys.fetch(stage)
+    rescue KeyError
+      raise Error,
+            "No such stage #{stage.inspect} in the configuration"
+    end
+
+    def field_key(field)
+      Streaker.configuration.field_keys.fetch(field)
+    rescue KeyError
+      raise Error,
+            "No such field #{field.inspect} in the configuration"
+    end
+
+    def update_attribute(attr, value)
+      case attr
+      when :stage
+        Streak::Box.update(key, stageKey: stage_key(value))
+      when :name
+        Streak::Box.update(key, name: value)
+      else
+        Streak::FieldValue.update(key, field_key(attr), value: value)
+      end
+    end
+  end
+end

data/lib/streaker/box_not_found_error.rb

@@ -0,0 +1,3 @@
+module Streaker
+  class BoxNotFoundError < StandardError; end
+end

data/lib/streaker/configuration.rb

@@ -0,0 +1,42 @@
+# Configuration variables and defaults.
+module Streaker
+  # The configuration singleton.
+  class Configuration
+    attr_reader :api_key
+    attr_accessor :pipeline_keys,
+                  :stage_keys,
+                  :field_keys
+
+    def initialize
+      @api_key = ''
+      @pipeline_keys = {}
+      @stage_keys = {}
+      @field_keys = {}
+    end
+
+    def api_key=(value)
+      @api_key = value
+
+      Streak.api_key = value
+    end
+  end
+
+  # Configuration setup
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+
+      if !configuration.api_key || configuration.api_key == ''
+        raise(ArgumentError, '`api_key` must be set in the configuration')
+      end
+
+      configuration
+    end
+  end
+end

data/lib/streaker/version.rb

@@ -0,0 +1,3 @@
+module Streaker
+  VERSION = '1.0.0'.freeze
+end

data/lib/streaker.rb

@@ -0,0 +1,6 @@
+require 'streak-ruby'
+
+require 'streaker/version'
+require 'streaker/configuration'
+require 'streaker/box'
+require 'streaker/box_not_found_error'

data/streaker.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'streaker/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name = 'streaker'
+  spec.version = Streaker::VERSION
+  spec.authors = ['Sunny Ripert', 'William Pollet']
+  spec.email = %w[
+    sunny.ripert@kisskissbankbank.com
+    william.pollet@KissKissBankBank.com
+  ]
+
+  spec.summary = 'Access the Streak API'
+  spec.description = 'Access the Streak API thanks to the streak-ruby gem'
+  spec.homepage = 'https://github.com/KissKissBankBank/streaker'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec|fixtures)/})
+  end
+  spec.require_paths = ['lib']
+
+  # API Bindings to Streak
+  spec.add_dependency 'streak-ruby', '>= 0.0.2', '< 1'
+
+  # Record HTTP Interactions
+  spec.add_development_dependency 'vcr', '~> 3.0'
+
+  # Mock HTTP requests
+  spec.add_development_dependency 'webmock', '~> 3.1'
+
+  # A different console for debugging
+  spec.add_development_dependency 'pry', '~> 0.11'
+
+  spec.add_development_dependency 'bundler', '>= 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  # Ruby linter
+  spec.add_development_dependency 'rubocop', '~> 0.51.0'
+end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: streaker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sunny Ripert
+- William Pollet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: streak-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+description: Access the Streak API thanks to the streak-ruby gem
+email:
+- sunny.ripert@kisskissbankbank.com
+- william.pollet@KissKissBankBank.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/streaker.rb
+- lib/streaker/box.rb
+- lib/streaker/box_not_found_error.rb
+- lib/streaker/configuration.rb
+- lib/streaker/version.rb
+- streaker.gemspec
+homepage: https://github.com/KissKissBankBank/streaker
+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.2
+signing_key: 
+specification_version: 4
+summary: Access the Streak API
+test_files: []
+has_rdoc: