lean-microsoft-graph 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a74cac3f33f72977f108ebd6df574cf7dfb8098dbd351d15dac1db3eafd138f
-  data.tar.gz: 01437d52cd8b78a5d685d1ed5bd95580633acedb266fd9f42d50a239e84b4409
+  metadata.gz: 68d12b40dc1ac7a49f0871b42827af0428474d472e9b06f6e6b18cdfaff67138
+  data.tar.gz: f6493c4f976717411ad7b1a0fb08ee97a0faf416dcfa99f05b7375675e89e0f2
 SHA512:
-  metadata.gz: 6eeb0692b9e32266cb13b6bfe61fd967f2c3d6a2842f4f373b2e6b071f46537d98bfc32a8a4223ace841f0bb20eb77080221eef5c62ef41d2bb8e2cc25f4010c
-  data.tar.gz: a7352b5942627897c0f99ead3fd6f165a6a0e65aaf506f003a20eae93e2675399b0edc16165e9a0d3a7bc73fee9ea61b597c866acd2205a1be7dfe22c674b3d2
+  metadata.gz: f38076f360a47acc6d05b4b985cf356503316bb90ab8c8e9ff826012005f26fbab25b03e092634987bda14987c2aefd887e7fe0c20d9c9ffce235e93e55e04ef
+  data.tar.gz: 25fe8eb56dafb3891d6b6409aa8e4605c4593e0272f9d3f60f131f7889e2da3d0f990ac1815643141baa14acff166ce22a4eb468c94b9e5096e80438f92a92f9

data/CHANGELOG.md

@@ -1,5 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [0.2.0] - 2023-11-04
+### Added
+- Ability to count users with `client.users.count`.
+- Ability to retrieve users per page with `client.users.get_all(per_page)`.
+- Ability to retrieve users by reference with `client.users.get_all_by_reference('reference')`.
+
 ## [Unreleased]
 
 ## [0.1.0] - 2023-08-28
 
 - Initial release
+
+[0.2.0]: https://github.com/betogrun/lean_microsoft_graph/releases/tag/v0.2.0

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+
+gem 'mocha', '~> 2.1'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    lean-microsoft-graph (0.1.0)
+      faraday (~> 1.10)
+      faraday_middleware (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    minitest (5.20.0)
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
+    multipart-post (2.3.0)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  lean-microsoft-graph!
+  minitest (~> 5.0)
+  mocha (~> 2.1)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.31

data/README.md

@@ -22,7 +22,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To start using the LeanMicrosoftGraph gem, you need to create a client instance by providing the tenant_id, client_id, and client_secret.
+
+### Initialize the client
+
+```ruby
+client = LeanMicrosoftGraph::Client.new(
+  tenant_id: 'your_tenant_id',
+  client_id: 'your_client_id',
+  client_secret: 'your_client_secret'
+)
+```
+
+Replace 'your_tenant_id', 'your_client_id', and 'your_client_secret' with your actual Microsoft Azure credentials.
+
+### Count the number of users
+
+```ruby
+count = client.users.count
+puts "Number of users: #{count}"
+```
+
+### Retrieving all users
+
+```ruby
+per_page = 10 # Set the number of users you want per page
+users = client.users.get_all(per_page)
+
+users.each do |user|
+  puts "User ID: #{user.id}"
+end
+```
 
 ## Development
 

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "lean/microsoft/graph"
+require "lean_microsoft_graph"
 
 # 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.

data/lib/lean_microsoft_graph/authentication/credentials.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  module Authentication
+    class Credentials
+      attr_reader :tenant_id, :client_id, :client_secret
+
+      def initialize(tenant_id, client_id, client_secret)
+        @tenant_id = tenant_id
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/authentication/token_retriever.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  module Authentication
+    class TokenRetriever
+      def initialize(token_resource)
+        @token_resource = token_resource
+        @token = nil
+      end
+
+      def to_proc
+        -> { retrieve }
+      end
+
+      def retrieve
+        return @token if @token && !@token.expired?
+
+        @token = @token_resource.renew
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  class Client
+    def initialize(tenant_id:, client_id:, client_secret:, adapter: Faraday.default_adapter, stubs: nil)
+      @tenant_id = tenant_id
+      @client_id = client_id
+      @client_secret = client_secret
+      @adapter = adapter
+      @stubs = stubs # Stubs for testing purpouses
+    end
+
+    def users
+      Resources::UsersResource.new(connection)
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: 'https://graph.microsoft.com/v1.0') do |faraday|
+        faraday.request :authorization, 'Bearer', proc(&token_retriever)
+        faraday.request :url_encoded
+        faraday.request :retry, retry_statuses: [429]
+        faraday.adapter @adapter, @stubs
+      end
+    end
+
+    def token_retriever
+      @token_retriever ||= begin
+        token_resource = Resources::TokenResource.new(credentials, @adapter, @stubs)
+        Authentication::TokenRetriever.new(token_resource)
+      end
+    end
+
+    def credentials
+      Authentication::Credentials.new(@tenant_id, @client_id, @client_secret)
+    end
+  end
+end

data/lib/lean_microsoft_graph/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  class Error < StandardError; end
+end

data/lib/lean_microsoft_graph/resource.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  class Resource
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_request(url, params = {}, headers = {}, &block)
+      handle_response(@connection.get(url, params, headers, &block))
+    end
+
+    def post_request(url, body = {}, headers = {}, &block)
+      handle_response(@connection.post(url, body, headers, &block))
+    end
+
+    private
+
+    def handle_response(response)
+    	parsed_response = JSON.parse(response.body, symbolize_names: true)
+      return parsed_response if (200..299).include?(response.status)
+
+      error_message = parsed_response[:error_description]
+      error_code = parsed_response[:error_codes]
+
+      puts parsed_response
+
+      case { status: response.status, code: error_code, message: error_message }
+      in { status: 400, code: code, message: message }
+        raise Error, "Bad request. Code: #{code}. Message: #{message}"
+      in { status: 401, code: code, message: message }
+        raise Error, "Unauthorized. Check permissions or authentication token. Code: #{code}. Message: #{message}"
+      in { status: 403, code: code, message: message }
+        raise Error, "Forbidden. Insufficient permissions. Code: #{code}. Message: #{message}"
+      in { status: 404, code: code, message: message }
+        raise Error, "Resource not found. Code: #{code}. Message: #{message}"
+      in { status: 429, code: code, message: message }
+        raise Error, "Too many requests. Rate limit exceeded. Code: #{code}. Message: #{message}"
+      in { status: 500, code: code, message: message }
+        raise Error, "Internal server error. Code: #{code}. Message: #{message}"
+      in { status: 503, code: code, message: message }
+        raise Error, "Service unavailable. Try again later. Code: #{code}. Message: #{message}"
+      else
+        raise Error, "An unknown error occurred with status: #{response.status}."
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/resources/token_resource/token.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  module Resources
+    class TokenResource
+      class Token
+        attr_reader :value, :expires_in
+
+        def initialize(value, expires_in)
+          @value = value
+          @expires_in = expires_in
+          @created_at = Time.now
+        end
+
+        def expires_at
+          @created_at + @expires_in
+        end
+
+        def expired?
+          Time.now > expires_at
+        end
+
+        def to_s
+          @value
+        end
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/resources/token_resource.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  module Resources
+    class TokenResource < ::LeanMicrosoftGraph::Resource
+      def initialize(credentials, adapter = Faraday.default_adapter, stubs = nil)
+        super(Faraday.new { |faraday| faraday.adapter(adapter, stubs)})
+        @credentials = credentials
+      end
+
+      def renew
+        url = "https://login.microsoftonline.com/#{@credentials.tenant_id}/oauth2/v2.0/token"
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        body = {
+          'client_id' => @credentials.client_id,
+          'scope' => 'https://graph.microsoft.com/.default',
+          'client_secret' => @credentials.client_secret,
+          'grant_type' => 'client_credentials'
+        }
+        response = post_request(url, URI.encode_www_form(body), headers)
+
+        Token.new(response[:access_token], response[:expires_in].to_i)
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/resources/users_resource/user.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  module Resources
+    class UsersResource
+      class User
+        def initialize(response)
+          @response = response
+        end
+
+        def id = @response[:id]
+
+        def display_name = @response[:displayName]
+
+        def mail = @response[:mail]
+
+        def user_principal_name = @response[:userPrincipalName]
+
+        def job_title = @response[:jobTitle]
+
+        def mobile_phone = @response[:mobilePhone]
+
+        def business_phones = @response[:businessPhones]
+
+        def given_name = @response[:givenName]
+
+        def surname = @response[:surname]
+
+        def preferred_language = @response[:preferredLanguage]
+
+        def office_location = @response[:officeLocation]
+
+        def to_h
+          {
+            id: id,
+            display_name: display_name,
+            mail: mail,
+            user_principal_name: user_principal_name,
+            job_title: job_title,
+            mobile_phone: mobile_phone,
+            business_phones: business_phones,
+            given_name: given_name,
+            surname: surname,
+            preferred_language: preferred_language,
+            office_location: office_location
+          }
+        end
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/resources/users_resource/users.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  module Resources
+    class UsersResource
+      class Users
+        include Enumerable
+
+        def initialize(response)
+          @response = response
+        end
+
+        def each(&block)
+          collection.each(&block)
+        end
+
+        def next_batch_reference = @response[:'@odata.nextLink']
+
+        private
+
+        def collection
+          @collection ||= @response[:value].map { |user| User.new(user) }
+        end
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/resources/users_resource.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  module Resources
+    class  UsersResource < ::LeanMicrosoftGraph::Resource
+      def count
+        get_request('users/$count') do |req|
+          req.headers['ConsistencyLevel'] = 'eventual'
+        end
+      end
+
+      def get_all(per_page)
+        response = get_request('users') do |req|
+          req.params['$top'] = per_page
+        end
+
+        Users.new(response)
+      end
+
+      def get_all_by_reference(url)
+        response = get_request(url)
+
+        Users.new(response)
+      end
+    end
+  end
+end

data/lib/lean_microsoft_graph/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LeanMicrosoftGraph
+  VERSION = "0.2.0"
+end

data/lib/lean_microsoft_graph.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+module LeanMicrosoftGraph
+  require 'lean_microsoft_graph/version'
+  require 'lean_microsoft_graph/error'
+  require 'lean_microsoft_graph/resource'
+  require 'lean_microsoft_graph/client'
+  require 'lean_microsoft_graph/authentication/credentials'
+  require 'lean_microsoft_graph/authentication/token_retriever'
+  require 'lean_microsoft_graph/resources/token_resource'
+  require 'lean_microsoft_graph/resources/token_resource/token'
+  require 'lean_microsoft_graph/resources/users_resource'
+  require 'lean_microsoft_graph/resources/users_resource/user'
+  require 'lean_microsoft_graph/resources/users_resource/users'
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: lean-microsoft-graph
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alberto Rocha
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-28 00:00:00.000000000 Z
-dependencies: []
+date: 2023-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: This gem provides a set of methods to interact with Microsoft Graph API.
 email:
 - betogrun@gmail.com
@@ -19,13 +47,24 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/lean/microsoft/graph.rb
-- lib/lean/microsoft/graph/version.rb
+- lib/lean_microsoft_graph.rb
+- lib/lean_microsoft_graph/authentication/credentials.rb
+- lib/lean_microsoft_graph/authentication/token_retriever.rb
+- lib/lean_microsoft_graph/client.rb
+- lib/lean_microsoft_graph/error.rb
+- lib/lean_microsoft_graph/resource.rb
+- lib/lean_microsoft_graph/resources/token_resource.rb
+- lib/lean_microsoft_graph/resources/token_resource/token.rb
+- lib/lean_microsoft_graph/resources/users_resource.rb
+- lib/lean_microsoft_graph/resources/users_resource/user.rb
+- lib/lean_microsoft_graph/resources/users_resource/users.rb
+- lib/lean_microsoft_graph/version.rb
 homepage: https://github.com/betogrun/lean-microsoft-graph
 licenses:
 - MIT
@@ -47,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: "'lean-microsoft-graph' is a gem is a simple interface to Microsoft Graph

data/lib/lean/microsoft/graph/version.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Lean
-  module Microsoft
-    module Graph
-      VERSION = "0.1.0"
-    end
-  end
-end

data/lib/lean/microsoft/graph.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "graph/version"
-
-module Lean
-  module Microsoft
-    module Graph
-      class Error < StandardError; end
-      # Your code goes here...
-    end
-  end
-end