velocity_client_ruby 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d19bcb60384a513c3b9dfb281561ebb20c542b2214054fe772ce2f01a6428b7
-  data.tar.gz: 89bfb6eecb38e4f16f7fea763e6432cfe2b6fbc4861cb5c8174ff03347d88cbf
+  metadata.gz: 1e2516b551ac58ec8b4f71195364e2cdb7400dc8efb70a4835cc0b3081e2bfe8
+  data.tar.gz: 95263628e3a1e4ae64d8a2f94e15df212c6c98917abbc89d66e4d288f25d22d8
 SHA512:
-  metadata.gz: cd1b2fef572887c31d1da03f9c15b431cbacf8eec9ded21dc8ea8eed95b7a244bbe8fd600fa313ed086bc006ca977c312d7af77f2f96eaee74db68fcc048daab
-  data.tar.gz: fda714153251af698e126e73109433c0bd47cc98669a2c1e925466baac21f9944746b736eb154ba5d7b43f0af2ec195fe0c860c70d00113df9a97d634061e72b
+  metadata.gz: 4c0e28a0e9ad13a549878cec86787cc562098a942fe9b406b0022ea59203eae70fba46f2e55d100743d2c4ffd38e8616b1dd0f7e766e7739cfff9aab7be16130
+  data.tar.gz: fcffcc10ea15e93ac12d1f4e0318bb71e9562105d8eb3081a86afa6bd57243338769955a0ab29dd96b39b917ec5f267900910ab75fd4dd9566a2694178346f5b

data/Gemfile.lock

@@ -48,4 +48,4 @@ DEPENDENCIES
   velocity_client_ruby!
 
 BUNDLED WITH
-   1.17.3
+   2.2.3

data/README.md

@@ -21,15 +21,27 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-Velocity.configure do |config|
-  config.api_token = "token"
-end
+require "velocity"
+
+contributors_list = CSV.parse(File.read('./examples/contributors-list.csv'), headers: true)
+
+contributors_list.map do |contributor|
+  velocity_contributor = Velocity::Contributor.find_by(name: contributor['name'])
 
-CSV.parse(File.read("contributors.csv"), headers: true).each do |contributor|
-  contributor = Velocity::Contributor.find(contributor.id)
+  if velocity_contributor
+     puts "Contributor #{velocity_contributor.id} found.\n#{velocity_contributor.inspect}"
+  else
+    role = Velocity::Role.find_by(name: contributor['role_name'])
+    raise 'Role not found' if role.nil?
 
-  if contributor.nil?
-    Velocity::Invite.create(email: contributor.email)
+    invite = Velocity::Invite.create(
+      name: contributor['name'],
+      email: contributor['email'],
+      job_function: contributor['job_function'],
+      role_ids: [role.id]
+    )
+
+    puts "Invite #{invite.id} sent.\n#{invite.inspect}"
   end
 end
 ```
@@ -40,6 +52,16 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+
+## Publishing
+
+1. Open version.rb file and version_spec.rb file and bump version
+2. run:
+
+```
+rake release
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/codeclimate/velocity-client-ruby. 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.

data/examples/contributors-list.csv

@@ -0,0 +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

data/examples/send_bulk_invites.rb

@@ -0,0 +1,25 @@
+require "bundler/setup"
+require "velocity"
+
+contributors_list = CSV.parse(File.read("./examples/contributors-list.csv"), headers: true)
+
+contributors_list.map do |contributor|
+  velocity_contributor = Velocity::Contributor.find_by(name: contributor["name"])
+
+  if velocity_contributor
+    puts "Contributor #{velocity_contributor.id} found.\n#{velocity_contributor.inspect}"
+  else
+    role = Velocity::Role.find_by(name: contributor["role_name"])
+
+    raise "Role not found" if role.nil?
+
+    invite = Velocity::Invite.create(
+      name: contributor["name"],
+      email: contributor["email"],
+      job_function: contributor["job_function"],
+      role_ids: [role.id]
+    )
+
+    puts "Invite #{invite.id} sent.\n#{invite.inspect}"
+  end
+end

data/examples/send_invite.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require "velocity"
+
+contributor = Velocity::Contributor.find_by(email: "vgsantoniazzi@gmail.com")
+
+if contributor
+  puts "Contributor #{contributor.id} found.\n#{contributor.inspect}"
+else
+  engineer_role = Velocity::Role.find_by(name: "Engineer")
+
+  raise "Role not found" if engineer_role.nil?
+
+  invite = Velocity::Invite.create(
+    name: "Victor Antoniazzi",
+    email: "vgsantoniazzi@gmail.com",
+    job_function: "Software Engineer",
+    role_ids: [engineer_role.id]
+  )
+
+  puts "Invite #{invite.id} sent.\n#{invite.inspect}"
+end

data/lib/initializers/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def deep_transform_keys(&block)
+    result = {}
+    each do |key, value|
+      result[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys(&block) : value
+    end
+    result
+  end
+end

data/lib/initializers/string.rb

@@ -0,0 +1,9 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end

data/lib/velocity/api/base.rb

@@ -0,0 +1,53 @@
+require "httparty"
+
+module Velocity
+  module Api
+    class Base
+      class NotFoundError < StandardError; end
+      class UnauthorizedError < StandardError; end
+      class InternalServerError < StandardError; end
+      class BadRequestError < StandardError; end
+
+      include HTTParty
+
+      base_uri "https://api.velocity.codeclimate.com/v1"
+
+      attr_accessor :args
+
+      def initialize(args)
+        @args = args
+      end
+
+      def options
+        {
+          headers: {
+            "Authorization" => "Bearer #{Velocity.configuration.api_token}",
+            "Content-Type" => "application/vnd.api+json",
+          }
+        }
+      end
+
+      def parse_response(response)
+        case response.code
+          when 200..201
+            JSON.parse(response.body)["data"]
+          when 400
+            errors = JSON.parse(response.body)["errors"]
+            raise BadRequestError.new(errors.first["title"] + ": " + errors.first["detail"])
+          when 401
+            raise UnauthorizedError.new("401 Unauthorized");
+          when 404
+            raise NotFoundError.new("404 not found error");
+          else
+            raise InternalServerError.new("#{response.code} something went wrong: #{response.body}")
+        end
+      end
+
+      def build_query
+        args.map do |key, value|
+          "filter[#{key.to_s}][contains]=#{value}"
+        end.join("&")
+      end
+    end
+  end
+end

data/lib/velocity/api/invite.rb

@@ -0,0 +1,42 @@
+module Velocity
+  module Api
+    class Invite < Velocity::Api::Base
+      def create
+        parse_response(self.class.post("/invitations", options.merge(body)))
+      end
+
+      def body
+        {
+          body: {
+            data: {
+              type: "invitations",
+              attributes: attributes,
+              relationships: relationships
+            }
+          }.to_json
+        }
+      end
+
+      def attributes
+        {
+          name: args.fetch(:name),
+          email: args.fetch(:email),
+          jobFunction: args.fetch(:job_function)
+        }
+      end
+
+      def relationships
+        {
+          roles: {
+            data: args.fetch(:role_ids).map do |role_id|
+              {
+                type: "roles",
+                id: role_id
+              }
+            end
+          }
+        }
+      end
+    end
+  end
+end

data/lib/velocity/api/people.rb

@@ -0,0 +1,9 @@
+module Velocity
+  module Api
+    class People < Velocity::Api::Base
+      def fetch
+        parse_response(self.class.get("/people", options.merge(query: build_query)))
+      end
+    end
+  end
+end

data/lib/velocity/api/role.rb

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

data/lib/velocity/base.rb

@@ -0,0 +1,36 @@
+module Velocity
+  class Base < OpenStruct
+    class NotFoundError < StandardError; end
+
+    class << self
+      attr_reader :resource_class_name
+
+      def resource_class(class_name = nil)
+        @resource_class_name ||= class_name
+      end
+    end
+
+    def initialize(args)
+      super(args.deep_transform_keys {|key| key.to_s.underscore })
+    end
+
+    def self.create(args)
+      data = resource_class.new(args).create
+      new(data["attributes"].merge(id: data["id"]))
+    end
+
+    def self.where(args)
+      resource_class.new(args).fetch.map do |data|
+        new(data["attributes"].merge(id: data["id"]))
+      end
+    end
+
+    def self.find_by(args)
+      where(args).first
+    end
+
+    def self.find_by!(args)
+      where(args).first or raise NotFoundError, "record not found with #{args.inspect}"
+    end
+  end
+end

data/lib/velocity/contributor.rb

@@ -1,21 +1,5 @@
 module Velocity
-  class Contributor
-    attr_accessor :id, :name, :email
-
-    def initialize(id:, email:, name:)
-      @id = id
-      @email = email
-      @name = name
-    end
-
-    def self.where(args)
-      perform_request(args).map do |contributor|
-        new(id: contributor["id"], name: contributor["attributes"]["name"], email: contributor["attributes"]["email"])
-      end
-    end
-
-    def self.perform_request(args = {})
-      Velocity::Api.new.fetch_contributors(args)
-    end
+  class Contributor < Base
+    resource_class Velocity::Api::People
   end
-end
+end

data/lib/velocity/invite.rb

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

data/lib/velocity/role.rb

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

data/lib/velocity/version.rb

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

data/lib/velocity.rb

@@ -1,5 +1,13 @@
-require "velocity/api"
+require "initializers/string"
+require "initializers/hash"
+require "velocity/api/base"
+require "velocity/api/role"
+require "velocity/api/people"
+require "velocity/api/invite"
+require "velocity/base"
+require "velocity/role"
 require "velocity/contributor"
+require "velocity/invite"
 require "dotenv/load"
 
 module Velocity

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: velocity_client_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Victor Antoniazzi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,9 +112,20 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/contributors-list.csv
+- examples/send_bulk_invites.rb
+- examples/send_invite.rb
+- lib/initializers/hash.rb
+- lib/initializers/string.rb
 - lib/velocity.rb
-- lib/velocity/api.rb
+- lib/velocity/api/base.rb
+- lib/velocity/api/invite.rb
+- lib/velocity/api/people.rb
+- lib/velocity/api/role.rb
+- lib/velocity/base.rb
 - lib/velocity/contributor.rb
+- lib/velocity/invite.rb
+- lib/velocity/role.rb
 - lib/velocity/version.rb
 - velocity_client_ruby.gemspec
 homepage: http://velocity.codeclimate.com

data/lib/velocity/api.rb

@@ -1,50 +0,0 @@
-require 'httparty'
-
-module Velocity
-  class Api
-    class NotFoundError < StandardError; end
-    class UnauthorizedError < StandardError; end
-    class InternalServerError < StandardError; end
-    class BadRequestError < StandardError; end
-
-    include HTTParty
-
-    base_uri "https://api.velocity.codeclimate.com/v1"
-
-    def initialize
-      @options = {
-        headers: {
-          authorization: "Bearer #{Velocity.configuration.api_token}"
-        }
-      }
-    end
-
-    def fetch_contributors(args)
-      parse_response(self.class.get("/people", @options.merge({
-        query: build_query_attributes(args)
-      })))
-    end
-
-    def parse_response(response)
-      case response.code
-        when 200
-          JSON.parse(response.body)["data"]
-        when 400
-          errors = JSON.parse(response.body)["errors"]
-          raise BadRequestError.new(errors.first["title"] + ": " + errors.first["detail"])
-        when 401
-          raise UnauthorizedError.new("401 Unauthorized");
-        when 404
-          raise NotFoundError.new("404 not found error");
-        else
-          raise InternalServerError.new("#{response.code} something went wrong: #{response.body}")
-      end
-    end
-
-    def build_query_attributes(args)
-      args.map do |key, value|
-        "filter[#{key.to_s}][eq]=#{value}"
-      end.join("&")
-    end
-  end
-end