officevibe 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9df36f56caf69bb5b93266d250c38aee1d41a7f742519cbf363192b2f734beea
-  data.tar.gz: c76d153bf31eae46d6991583eecbdbb3e21f0349d82ef4d0fd5f1acbb7bcf669
+  metadata.gz: 942d85a5bb8d7d60350a411f852204b13bbddb19eadfd5c13b5340e2a69220e6
+  data.tar.gz: cda5c25f277bb750bb306743f465b1f3977df79f0cbacd3e4202eb4a7729e728
 SHA512:
-  metadata.gz: eb21aae1014fa5c8df29895095f80eeb2f71560a2bc7f7d537db309d1ead6b719a0a3f731fe3310d9fd38a2813c499cf70fab0a718020b8675604f3d07f40e82
-  data.tar.gz: 281ae19e269c646c8c91bfbceb4f51e4215c3d958886e41af1a47a7b7ac13695e0ae493f9c735bab4fff578dda88c0254a6b0b0dfa810c2f2ff655e3edee0c55
+  metadata.gz: 6e04f8210a018deeb8f7d78362bac5b3901ac1cb00282ed11e6678d92f5f783f37e0582dc4625774d30312e00b7ee5f099bdb917682530caa93fa1bc5796ca47
+  data.tar.gz: 568a7cb177e7e83d3d4cb25133390f5b15ab81c5d081f1ab4f8aa8b041f77752e98a1ec94bc55f01a6d3cec66abe996c36b984743826c9521db9341b3cc82e04

data/.gitignore

@@ -6,6 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
 .rspec_status
+.auth_token
+*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -1,20 +1,36 @@
 PATH
   remote: .
   specs:
-    officevibe (0.1.0)
+    officevibe (0.1.1)
+      activesupport (~> 5.2)
       faraday_middleware (~> 0.13.1)
       json (~> 2.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    awesome_print (1.8.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
     multipart-post (2.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -29,13 +45,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print (~> 1.8.0)
   bundler (~> 2.0)
   officevibe!
+  pry (~> 0.12.2)
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,8 +1,6 @@
 # Officevibe
 
-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/officevibe`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An early-stage Ruby client for Officevibe.
 
 ## Installation
 
@@ -20,9 +18,56 @@ Or install it yourself as:
 
     $ gem install officevibe
 
+## Configuration
+
+To get your auth token log in to the Officevibe app and copy the value of the officevibe.auth cookie; this can be done through the Developer Tools of your browser or any number of browser extensions (like EditThisCookie for Chrome).
+
+```ruby
+client = Officevibe::Client.new("<your auth token here>")
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+### Get Manageable Groups
+
+```ruby
+client.get_groups
+# => [
+#     {
+#                   "id" => "12345678-1234-5678-9012-12345678901",
+#         "display_name" => "Accounting Department"
+#     }
+# ]
+```
+
+### Get Engagement Report
+
+```ruby
+client.get_engagement_report("12345678-1234-5678-9012-12345678901")
+# => {"metric_groups"=>
+#   [{"id"=>"MG-4",
+#     "description"=>"The \"Relationship with Manager\" metric represents trust, communication and collaboration between employees and their direct manager.",
+#     "title"=>"Relationship with Manager",
+#     "is_effective"=>true,
+#     "value"=>9.9,
+#     "graph"=>
+#      {"scale_min"=>8.1,
+#       "scale_max"=>9.7,
+#       "zoom"=>6.25,
+#       "offset"=>0.39,
+#       "min_value"=>0.0,
+#       "max_value"=>10.0,
+#       "interval_type"=>3,
+#       "values"=>
+#        [{"date"=>"2019-04-14T00:00:00Z", "value"=>9.9},
+#         {"date"=>"2019-04-21T00:00:00Z", "value"=>9.9},
+#         {"date"=>"2019-04-28T00:00:00Z", "value"=>9.9},
+#         {"date"=>"2019-05-05T00:00:00Z", "value"=>9.9},
+#         {"date"=>"2019-05-12T00:00:00Z", "value"=>9.9},
+#         {"date"=>"2019-05-19T00:00:00Z", "value"=>9.9},
+#         {"date"=>"2019-05-26T00:00:00Z", "value"=>9.9},
+#         {"date"=>"2019-06-02T00:00:00Z", "value"=>9.9},
+```
 
 ## Development
 
@@ -32,7 +77,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/officevibe. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/chrisb/officevibe. 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.
 
 ## License
 
@@ -40,4 +85,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Officevibe project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/officevibe/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Officevibe project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/chrisb/officevibe/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -2,13 +2,17 @@
 
 require "bundler/setup"
 require "officevibe"
+require "awesome_print"
 
 # 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.
 
+auth_token = File.read("./.auth_token").strip
+@client = Officevibe::Client.new(auth_token)
+
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/lib/officevibe/client.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
+require "faraday_middleware"
+require "date"
+require "officevibe/client_middleware"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/to_query"
 
 module Officevibe
   class Client
@@ -15,6 +22,8 @@ module Officevibe
       @auth_token = auth_token
       @connection = Faraday.new url: OFFICEVIBE_URL, headers: headers do |conn|
         conn.response :json, :content_type => /\bjson$/
+        conn.response :raise_error
+        conn.use Officevibe::ClientMiddleware
         conn.adapter Faraday.default_adapter
       end
     end

data/lib/officevibe/client_middleware.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Officevibe
+  Error = Class.new(StandardError)
+  InvalidAuthToken = Class.new(Officevibe::Error)
+
+  class ClientMiddleware < Faraday::Response::Middleware
+    def on_complete(env)
+      case env[:status]
+      when 302
+        raise Officevibe::InvalidAuthToken, JSON.parse(env.body)["message"]
+      end
+    end
+  end
+end

data/lib/officevibe/version.rb

@@ -1,3 +1,3 @@
 module Officevibe
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/officevibe.rb

@@ -1,7 +1,2 @@
 require "officevibe/version"
 require "officevibe/client"
-
-module Officevibe
-  class Error < StandardError; end
-  # Your code goes here...
-end

data/officevibe.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["chrisb@users.noreply.github.com"]
 
   spec.summary       = "An Officevibe client for Ruby"
-  spec.description   = "An Officevibe client for Ruby"
+  spec.description   = "An Officevibe client for Ruby. Currently supports only a few things."
   spec.homepage      = "https://github.com/chrisb/officevibe-ruby"
   spec.license       = "MIT"
 
@@ -25,8 +25,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday_middleware", "~> 0.13.1"
   spec.add_dependency "json", "~> 2.2.0"
+  spec.add_dependency "activesupport", "~> 5.2"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "awesome_print", "~> 1.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: officevibe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Bielinski
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: An Officevibe client for Ruby
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: An Officevibe client for Ruby. Currently supports only a few things.
 email:
 - chrisb@users.noreply.github.com
 executables: []
@@ -100,6 +142,7 @@ files:
 - bin/setup
 - lib/officevibe.rb
 - lib/officevibe/client.rb
+- lib/officevibe/client_middleware.rb
 - lib/officevibe/version.rb
 - officevibe.gemspec
 homepage: https://github.com/chrisb/officevibe-ruby