streaker 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bc2a4a60a0faa7cc2b4a9d4c9dd926a5bbed55f
-  data.tar.gz: 666da415df2bf8e6111dad1af75cc1a78239d477
+  metadata.gz: 9e20542e5dc258218ae5ed0778b4c415669b0f66
+  data.tar.gz: 6687c299e86cc61b48c9dd52c8270829dac2bfe4
 SHA512:
-  metadata.gz: 384896b543a2460b39c15fadef23d5144bc29c5a3c57e15cb60710296f5235c96bc6395fb91c1ac093e4144a93500fd016d05ea3574542b16023e949decbf0e6
-  data.tar.gz: 8dd14b39543a428545249b893d268aef075937ac6ffd84486f685fce60d2473d72f1fd24e50eaccf28f4c92fedda9cf9e04a1cbdde8c6d126ced205f6d8abd4c
+  metadata.gz: 93ede4c70c91e869c14b212ac50344d6194511e4d5eb06b8e49458efe6ca8c7ec4cd12adf67e8e51029a8479383ab54d9b5f3e53d7adef87976797217e4b2fd4
+  data.tar.gz: 8432974d66b3cc9a70269ee69a04bed26f612f6b9eb8b66cda65e1b5177399228cfb97a1d3cf56783aca6e8f152eedd3b122f283bed3f27a819b986b45d9d3a8

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.0] - 2018-08-21
+
+Features:
+- Replace `streak-ruby` dependency by `http`.
+- Make only one call to update a box instead of one per attribute.
+- Create a box with persons assigned.
+
 ## [1.0.0] - 2017-12-11
 
 First release! :tada:

data/README.md

@@ -33,6 +33,7 @@ box = Streaker::Box.create(
   name: 'Some box name',
   stage: :my_stage,
   my_field: 'Some field value',
+  assigned_to: ['streak-owner@email.com', 'streak-contributor@email.com', …]
   …
 )
 box.key # => your new box's key
@@ -43,11 +44,13 @@ Update a box:
 ```rb
 box = Streaker::Box.new('a_box_key')
 box.update(
+  name: 'my box name',
+  stage: :some_other_stage,
   my_field: 'A new field value',
-  …
 )
 ```
 
+
 ## Configuration
 
 Configure Streaker:
@@ -60,6 +63,7 @@ Streaker.configure do |config|
   # 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',
@@ -82,7 +86,6 @@ Streaker.configure do |config|
   # 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)

data/lib/streaker/api.rb

@@ -0,0 +1,82 @@
+module Streaker
+  # Allow the streaker gem to execute http calls to the streak api
+  class API
+    STREAK_URL = 'https://www.streak.com'.freeze
+
+    def initialize(api_key: nil)
+      @api_key = api_key || Streaker.configuration.api_key
+    end
+
+    def update_box(key, attributes)
+      response = client.post(
+        "#{STREAK_URL}/api/v1/boxes/#{key}",
+        json: update_box_params(attributes)
+      )
+
+      JSON.parse(response.body.to_s)
+    end
+
+    def create_box(pipeline_key, name:, assigned_to: [])
+      response = client.put(
+        "#{STREAK_URL}/api/v1/pipelines/#{pipeline_key}/boxes",
+        form: create_box_params(name: name, assigned_to: assigned_to)
+      )
+
+      JSON.parse(response.body.to_s)
+    end
+
+    def find_box(box_key)
+      response = client.get(
+        "#{STREAK_URL}/api/v1/boxes/#{box_key}"
+      )
+
+      JSON.parse(response.body.to_s)
+    end
+
+    private_constant :STREAK_URL
+
+    private
+
+    attr_reader :api_key
+
+    def update_box_params(attributes)
+      {
+        name: attributes.delete(:name),
+        stageKey: find_streak_stage_key_key(attributes.delete(:stage)),
+        fields: format_fields_for_streak(attributes)
+      }.delete_if { |_k, v| v.nil? }
+    end
+
+    def create_box_params(name:, assigned_to: [])
+      return { name: name } unless assigned_to.any?
+
+      {
+        name: name,
+        assignedToSharingEntries: format_emails(assigned_to).to_json
+      }
+    end
+
+    def format_emails(array)
+      array.map do |email|
+        {
+          email: email
+        }
+      end
+    end
+
+    def format_fields_for_streak(attributes)
+      attributes.map { |k, v| [Streaker.configuration.field_keys[k], v] }.to_h
+    end
+
+    def find_streak_stage_key_key(key)
+      Streaker.configuration.stage_keys[key]
+    end
+
+    def client
+      @client ||= HTTP.headers(accept: 'application/json').basic_auth(
+        user: api_key,
+        pass: ''
+      )
+    end
+  end
+end

data/lib/streaker/box.rb

@@ -22,10 +22,9 @@ module Streaker
     # You can also give a `stage: :stage` or
     def update(attributes)
       verify_if_box_exists
+      api_result = api.update_box(key, attributes)
 
-      attributes.each do |attr, value|
-        update_attribute(attr, value)
-      end
+      raise Streaker::Box::Error, api_result['error'] if api_result['error']
 
       true
     end
@@ -38,11 +37,19 @@ module Streaker
     #       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
+    def self.create(name:, pipeline: :default, assigned_to: [], **attributes)
+      api = Streaker::API.new
+      api_result = api.create_box(
+        pipeline_key(pipeline),
+        name: name,
+        assigned_to: assigned_to
+      )
+
+      raise Streaker::Box::Error, api_result['error'] if api_result['error']
+
+      api.update_box(api_result['key'], name: name, **attributes)
+
+      new(api_result['key'])
     end
 
     def self.pipeline_key(pipeline)
@@ -57,13 +64,15 @@ module Streaker
     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
+      result = api.find_box(key)
+
+      return unless result['error']
+
+      if /Entity not found with key/ =~ result['error']
+        raise Streaker::BoxNotFoundError, result['error']
       end
+
+      raise Streaker::Box::Error, result['error']
     end
 
     def stage_key(stage)
@@ -80,15 +89,8 @@ module Streaker
             "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
+    def api
+      Streaker::API.new
     end
   end
 end

data/lib/streaker/configuration.rb

@@ -2,10 +2,10 @@
 module Streaker
   # The configuration singleton.
   class Configuration
-    attr_reader :api_key
     attr_accessor :pipeline_keys,
                   :stage_keys,
-                  :field_keys
+                  :field_keys,
+                  :api_key
 
     def initialize
       @api_key = ''
@@ -13,12 +13,6 @@ module Streaker
       @stage_keys = {}
       @field_keys = {}
     end
-
-    def api_key=(value)
-      @api_key = value
-
-      Streak.api_key = value
-    end
   end
 
   # Configuration setup

data/lib/streaker/version.rb

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

data/lib/streaker.rb

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

data/streaker.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['Sunny Ripert', 'William Pollet']
   spec.email = %w[
     sunny.ripert@kisskissbankbank.com
-    william.pollet@KissKissBankBank.com
+    william.pollet@kisskissbankbank.com
   ]
 
   spec.summary = 'Access the Streak API'
@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  # API Bindings to Streak
-  spec.add_dependency 'streak-ruby', '>= 0.0.2', '< 1'
+  # API calls
+  spec.add_development_dependency 'http', '~> 3.3.0'
 
   # Record HTTP Interactions
   spec.add_development_dependency 'vcr', '~> 3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streaker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sunny Ripert
@@ -9,28 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: streak-ruby
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
+        version: 3.3.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +126,7 @@ dependencies:
 description: Access the Streak API thanks to the streak-ruby gem
 email:
 - sunny.ripert@kisskissbankbank.com
-- william.pollet@KissKissBankBank.com
+- william.pollet@kisskissbankbank.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -150,6 +144,7 @@ files:
 - bin/console
 - bin/setup
 - lib/streaker.rb
+- lib/streaker/api.rb
 - lib/streaker/box.rb
 - lib/streaker/box_not_found_error.rb
 - lib/streaker/configuration.rb
@@ -174,9 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Access the Streak API
 test_files: []
-has_rdoc: