velocity_client_ruby 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e2516b551ac58ec8b4f71195364e2cdb7400dc8efb70a4835cc0b3081e2bfe8
-  data.tar.gz: 95263628e3a1e4ae64d8a2f94e15df212c6c98917abbc89d66e4d288f25d22d8
+  metadata.gz: 5eec482e30a02e7f2ffb015d5fe6c192cf3f1fdcaaa4c3b6e7ceaf11994269dc
+  data.tar.gz: 8b141bb370fe3e3cdab469e59a75b269ef8cc2a4e15c66b8dccb87c74934c9e5
 SHA512:
-  metadata.gz: 4c0e28a0e9ad13a549878cec86787cc562098a942fe9b406b0022ea59203eae70fba46f2e55d100743d2c4ffd38e8616b1dd0f7e766e7739cfff9aab7be16130
-  data.tar.gz: fcffcc10ea15e93ac12d1f4e0318bb71e9562105d8eb3081a86afa6bd57243338769955a0ab29dd96b39b917ec5f267900910ab75fd4dd9566a2694178346f5b
+  metadata.gz: e6fdda65e7f609d69492e86aa2f304b30622645dc24768005def33e3fd02963b5ea3e31b0e17031e21205c729adc31a29e91dd3794982fcd90e9c84b305fb0ff
+  data.tar.gz: 30dd425047f3cfa9bc95b95e627e2d697ec31feabade6d6cf937b7c08be60bb321f5735b748be134754741be818f8947ead70ab21e1ce96497c28e1236759e5d

data/Gemfile.lock

@@ -1,28 +1,35 @@
 PATH
   remote: .
   specs:
-    velocity_client_ruby (0.1.1)
+    velocity_client_ruby (0.3.0)
       dotenv (~> 2.7)
       httparty (~> 0.18)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    httparty (0.18.1)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0704)
+    mime-types-data (3.2021.0901)
     multi_xml (0.6.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (4.0.6)
     rake (10.5.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -36,16 +43,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.2.3)
   pry (~> 0.14)
   rake (~> 10.0)
   rspec (~> 3.0)
+  vcr (~> 6.0)
   velocity_client_ruby!
+  webmock (~> 3.14)
 
 BUNDLED WITH
    2.2.3

data/README.md

@@ -18,30 +18,40 @@ Or install it yourself as:
 
     $ gem install velocity_client_ruby
 
+## Configuration
+
+In order to be able to Access Velocity API you need to have a token.
+You can set it up all your environemnt variables using configure method:
+
+```ruby
+  Velocity.configure do |config|
+    config.api_token = "<TOKEN>"
+  end
+```
+
 ## Usage
 
 ```ruby
 require "velocity"
 
-contributors_list = CSV.parse(File.read('./examples/contributors-list.csv'), headers: true)
+list = CSV.parse(File.read('./examples/contributors.csv'), headers: true)
 
-contributors_list.map do |contributor|
-  velocity_contributor = Velocity::Contributor.find_by(name: contributor['name'])
+list.map do |contributor_data|
+  contributor = Velocity::Contributor.find_by(name: contributor_data['name'])
 
-  if velocity_contributor
-     puts "Contributor #{velocity_contributor.id} found.\n#{velocity_contributor.inspect}"
+  if contributor
+     puts "Contributor #{contributor.id} found."
   else
-    role = Velocity::Role.find_by(name: contributor['role_name'])
-    raise 'Role not found' if role.nil?
+    role = Velocity::Role.find_by(name: contributor_data['role_name'])
 
     invite = Velocity::Invite.create(
-      name: contributor['name'],
-      email: contributor['email'],
-      job_function: contributor['job_function'],
+      name: contributor_date['name'],
+      email: contributor_data['email'],
+      job_function: contributor_data['job_function'],
       role_ids: [role.id]
     )
 
-    puts "Invite #{invite.id} sent.\n#{invite.inspect}"
+    puts "Invite #{invite.id} sent."
   end
 end
 ```

data/examples/contributors-list.csv

@@ -1,5 +1,5 @@
 name,email,job_function,role_name
-Vera Prot,vera@codeclimate.com,Software Engineer,Engineer
-Victor Antoniazzi,vantoniazzi@codeclimate.com,Software Engineer,Engineer
-Alex Oliveira,aoliveira@codeclimate.com,Software Engineer,Engineer
-Filipe Esperandio,filipe@codeclimate.com,Software Engineer,Engineer
+Vera Prot,vera@fakemail.com,Software Engineer,Engineer
+Victor Antoniazzi,victor@fakemail.com,Software Engineer,Engineer
+Alex Oliveira,alex@fakemail.com,Software Engineer,Engineer
+Filipe Esperandio,filipe@fakemail.com,Software Engineer,Engineer

data/lib/velocity/api/base.rb

@@ -8,6 +8,8 @@ module Velocity
       class InternalServerError < StandardError; end
       class BadRequestError < StandardError; end
 
+      PAGE_SIZE = 100
+
       include HTTParty
 
       base_uri "https://api.velocity.codeclimate.com/v1"
@@ -18,15 +20,20 @@ module Velocity
         @args = args
       end
 
-      def options
-        {
-          headers: {
-            "Authorization" => "Bearer #{Velocity.configuration.api_token}",
-            "Content-Type" => "application/vnd.api+json",
-          }
-        }
+      def get(url)
+        parse_response(self.class.get(url, options.merge(query: build_query)))
+      end
+
+      def post(url, body)
+        parse_response(self.class.post("/invitations", options.merge(body)))
       end
 
+      def put(url, body)
+        parse_response(self.class.put(url, options.merge(body)))
+      end
+
+      private
+
       def parse_response(response)
         case response.code
           when 200..201
@@ -43,10 +50,28 @@ module Velocity
         end
       end
 
+      def options
+        {
+          headers: {
+            "Authorization" => "Bearer #{Velocity.configuration.api_token}",
+            "Content-Type" => "application/vnd.api+json",
+          }
+        }
+      end
+
       def build_query
         args.map do |key, value|
-          "filter[#{key.to_s}][contains]=#{value}"
-        end.join("&")
+          "filter[#{key.to_s}][#{operation(key)}]=#{value}"
+        end.join("&") + "&page[size]=100"
+      end
+
+      def operation(key)
+        case key.to_sym
+        when :id
+          "eq"
+        else
+          "contains"
+        end
       end
     end
   end

data/lib/velocity/api/invite.rb

@@ -2,9 +2,11 @@ module Velocity
   module Api
     class Invite < Velocity::Api::Base
       def create
-        parse_response(self.class.post("/invitations", options.merge(body)))
+        post("/invitations", body)
       end
 
+      private
+
       def body
         {
           body: {

data/lib/velocity/api/people.rb

@@ -2,7 +2,38 @@ module Velocity
   module Api
     class People < Velocity::Api::Base
       def fetch
-        parse_response(self.class.get("/people", options.merge(query: build_query)))
+        get("/people")
+      end
+
+      def update
+        put("/people/#{args.fetch(:id)}", body)
+      end
+
+      private
+
+      def body
+        {
+          body: {
+            data: {
+              id: args.fetch(:id),
+              type: "people",
+              relationships: relationships
+            }
+          }.to_json
+        }
+      end
+
+      def relationships
+        {
+          teams: {
+            data: args.fetch(:team_ids).map do |team_id|
+              {
+                type: "teams",
+                id: team_id
+              }
+            end
+          }
+        }
       end
     end
   end

data/lib/velocity/api/role.rb

@@ -2,7 +2,7 @@ module Velocity
   module Api
     class Role < Velocity::Api::Base
       def fetch
-        parse_response(self.class.get("/roles", options.merge(query: build_query)))
+        get("/roles")
       end
     end
   end

data/lib/velocity/api/team.rb

@@ -0,0 +1,9 @@
+module Velocity
+  module Api
+    class Team < Velocity::Api::Base
+      def fetch
+        get("/teams")
+      end
+    end
+  end
+end

data/lib/velocity/base.rb

@@ -19,6 +19,12 @@ module Velocity
       new(data["attributes"].merge(id: data["id"]))
     end
 
+    def self.all
+      resource_class.new({}).fetch.map do |data|
+        new(data["attributes"].merge(id: data["id"]))
+      end
+    end
+
     def self.where(args)
       resource_class.new(args).fetch.map do |data|
         new(data["attributes"].merge(id: data["id"]))
@@ -32,5 +38,10 @@ module Velocity
     def self.find_by!(args)
       where(args).first or raise NotFoundError, "record not found with #{args.inspect}"
     end
+
+    def update(args)
+      data = self.class.resource_class.new(args.merge(id: self.id)).update
+      self.class.new(data["attributes"].merge(id: data["id"]))
+    end
   end
 end

data/lib/velocity/team.rb

@@ -0,0 +1,5 @@
+module Velocity
+  class Team < Base
+    resource_class Velocity::Api::Team
+  end
+end

data/lib/velocity/version.rb

@@ -1,3 +1,3 @@
 module Velocity
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/velocity.rb

@@ -4,10 +4,12 @@ require "velocity/api/base"
 require "velocity/api/role"
 require "velocity/api/people"
 require "velocity/api/invite"
+require "velocity/api/team"
 require "velocity/base"
 require "velocity/role"
 require "velocity/contributor"
 require "velocity/invite"
+require "velocity/team"
 require "dotenv/load"
 
 module Velocity

data/velocity_client_ruby.gemspec

@@ -33,9 +33,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.2.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.14"
   spec.add_development_dependency "pry", "~> 0.14"
 
   spec.add_dependency  "httparty", "~> 0.18"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: velocity_client_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Victor Antoniazzi
 - Vera Protopopova
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +53,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -122,10 +150,12 @@ files:
 - lib/velocity/api/invite.rb
 - lib/velocity/api/people.rb
 - lib/velocity/api/role.rb
+- lib/velocity/api/team.rb
 - lib/velocity/base.rb
 - lib/velocity/contributor.rb
 - lib/velocity/invite.rb
 - lib/velocity/role.rb
+- lib/velocity/team.rb
 - lib/velocity/version.rb
 - velocity_client_ruby.gemspec
 homepage: http://velocity.codeclimate.com
@@ -134,7 +164,7 @@ licenses:
 metadata:
   homepage_uri: http://velocity.codeclimate.com
   source_code_uri: https://github.com/codeclimate/velocity-client-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +179,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.8
+signing_key: 
 specification_version: 4
 summary: Ruby Gem to interact with Velocity Teams API
 test_files: []