yandex360 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b11c6de45c29a60108327582acc5bb36035f265d2efa3dcef034149c21cda2dc
-  data.tar.gz: de47f74b9d82709188a8b79d0bf5105b27e45496dbc0f2b2442b739bc02554c8
+  metadata.gz: 76cb70cc7abcc7012654e816187c056ee7c7662ed3d6532458295dcbe8d251bc
+  data.tar.gz: d73c143a23cae1e185726279c1adb32020793ca9bf0eb30e3b19510459c9db2b
 SHA512:
-  metadata.gz: 3933e9edbb6c71d5babd27fdeb46aba720d5f7dc94773fe6843dcf81e037f8feb01af16ee28a25a3494edc56968fbe9afcd73cfe764c6c3c71eb8a7b6d8abf8b
-  data.tar.gz: 4c3e0d3753c47bf4278fa0b013fbc174ee800bf834dbdbb99071cbbcea3e91d96cdb0de4d8e9d01ff2b430607b6f2f315ac09e8b8117e11d2f60e390081bdd6f
+  metadata.gz: a4f7532f4a5a7da9502c5ef0b2267768827245dfd4c2632f1db61f6130c2cabc2692ce66c449eeaec1496f9ad023cb8eddccc3310c9345df4d78e53671890f42
+  data.tar.gz: '088a2139e3200ea6086e5a54f6113de08917f9050f40444f53f80ee40ad0c98706d72178094e84386c7a9b10ee80c2792109b743e117d8b312d0a8eecf86bf32'

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+      open-pull-requests-limit: 20
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      open-pull-requests-limit: 20

data/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: Ruby specs
+on: [push, pull_request]
+jobs:
+  test:
+    name: tests
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['2.6', '2.7', '3.0', '3.1', head, truffleruby, truffleruby-head]
+    runs-on: ${{ matrix.os }}
+    continue-on-error: true
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Get the newest rubygems version to rid ourselves of warnings
+      run: gem update --system --no-document
+
+    - name: Install bundler
+      run: gem i bundler --no-document
+
+    - name: Install dependencies
+      run: |
+        bundle config set --local without benchmark
+        bundle install --jobs=3
+    - name: RSpec testing
+      run: |
+        JRUBY_OPTS="--dev --debug" bundle exec rspec --color --format documentation
+    - name: Coveralls Parallel
+      uses: coverallsapp/github-action@1.1.3
+      with:
+        github-token: ${{ secrets.github_token }}
+        flag-name: run-${{ matrix.ruby-version }}
+        path-to-lcov: ./coverage/lcov/yandex360.lcov
+        parallel: true
+
+  coverage:
+    name: Coverage
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@1.1.3
+      with:
+        github-token: ${{ secrets.github_token }}
+        path-to-lcov: ${{ github.workspace }}/coverage/lcov.info
+        parallel-finished: true

data/.gitignore

@@ -34,4 +34,7 @@ build/
 .rvmrc
 
 ## macos
-.DS_Store
+.DS_Store
+dev
+
+.rspec_status

data/.rspec

@@ -0,0 +1,5 @@
+--tty
+--color
+--format documentation # progress
+--backtrace
+--require spec_helper

data/Gemfile

@@ -3,12 +3,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-# gem "addressable", "~> 2.3", ">= 2.3.7"
-# gem "minitest", ">= 5.0.5"
-# gem "rake"
-# gem "standard"
-
-# gem "rspec"
-# gem "vcr"
-# gem "webmock"

data/Gemfile.lock

@@ -1,16 +1,19 @@
 PATH
   remote: .
   specs:
-    yandex360 (0.0.1)
+    yandex360 (1.1.0)
       addressable (~> 2.3, >= 2.3.7)
       faraday (~> 1.7)
-      faraday_middleware (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
     faraday (1.10.2)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -34,16 +37,49 @@ GEM
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    hashdiff (1.0.1)
     multipart-post (2.2.3)
     public_suffix (5.0.0)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
     ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.7.0)
+    simplecov_json_formatter (0.1.4)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-darwin-17
 
 DEPENDENCIES
+  bundler
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+  simplecov (~> 0.9)
+  simplecov-lcov (~> 0.7.0)
+  vcr (~> 6.1)
+  webmock (~> 3.18, >= 3.18.1)
   yandex360!
 
 BUNDLED WITH

data/README.md

@@ -1 +1,72 @@
-# yandex360 - wip
+# Yandex 360 - Ruby API client ([gem](https://rubygems.org/gems/yandex360))
+
+[![Gem Version](https://badge.fury.io/rb/yandex360.svg)](https://badge.fury.io/rb/yandex360)
+![Gem](https://img.shields.io/gem/dt/yandex360)
+![GitHub](https://img.shields.io/github/license/ruby-api-client/yandex360)
+## Installation
+
+### Gemfile
+
+```gemfile
+gem 'yandex360', '~> 1.0', '>= 1.0.1'
+```
+
+### Install
+
+```sh
+gem install yandex360
+```
+
+## Getting started
+
+```ruby
+    require "yandex360"
+
+    yandex360 = Yandex360::Client.new(token: "paste your access_token here")
+
+    users = yandex360.users.list(org_id: 1234567)
+```
+
+## Available methods
+
+```ruby
+# Antispam
+antispam.list(org_id:)
+antispam.create(org_id, *strings)
+antispam.delete(org_id:)
+
+# Users
+users.add(org_id:, dep_id:, **user_params)
+users.add_alias(org_id:, user_id:, user_alias:)
+users.update(org_id:, user_id:, **user_params)
+users.info(org_id:, user_id:)
+users.list(org_id:, page: 1, per_page: 10)
+users.get2FA(org_id:, user_id:)
+users.has2FA?(org_id:, user_id:)
+users.delete_alias(org_id:, user_id:, user_alias:)
+
+# Departments
+departments.add_alias(org_id:, dep_id:, name:)
+departments.update(org_id:, dep_id:, parent_id:, **params)
+departments.info(org_id:, dep_id:)
+departments.list(org_id:, page: 1, per_page: 10, parent_id: 0, order_by: "id")
+departments.create(org_id:, name:, parent_id:, **params)
+departments.delete_alias(org_id:, dep_id:, name:)
+departments.delete(org_id:, dep_id:)
+
+# Groups
+groups.add_user(org_id:, group_id:, user_id:, type: "user")
+groups.update(org_id:, group_id:, **user_params)
+groups.params(org_id:, group_id:)
+groups.list(org_id:, page: 1, per_page: 10)
+groups.users(org_id:, group_id:)
+groups.create(org_id:, name:, **group_params)
+groups.delete(org_id:, group_id:)
+groups.delete_user(org_id:, group_id:, type:, user_id:)
+```
+
+## TODO
+
+- examples
+- documentation
+- ~~tests~~

data/lib/yandex360/client.rb

@@ -13,13 +13,28 @@ module Yandex360
       @stubs = stubs # Test stubs for requests
     end
 
+    def antispam
+      AntispamResource.new(self)
+    end
+
+    def departments
+      DepartmentsResource.new(self)
+    end
+
+    def groups
+      GroupsResource.new(self)
+    end
+
+    def users
+      UsersResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :OAuth, token
         conn.request :json
         conn.request :url_encoded
 
-        conn.response :dates
         conn.response :json, content_type: "application/json"
 
         conn.adapter adapter, @stubs

data/lib/yandex360/collection.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class Collection
+    attr_reader :data, :items, :total
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      new(
+        data: body[key].map {|attrs| type.new(attrs) },
+        items: body["items"],
+        total: body["total"]
+      )
+    end
+
+    def initialize(data:, items:, total:)
+      @data   = data
+      @items  = items
+      @total  = total
+    end
+  end
+end

data/lib/yandex360/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class Error < StandardError
+  end
+end

data/lib/yandex360/object.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Yandex360
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    # Convert Array or Hash to OpenStruct
+    def to_ostruct(obj)
+      case obj
+      when Hash
+        # rubocop:disable Style/HashTransformValues
+        OpenStruct.new(obj.map {|key, val| [key, to_ostruct(val)] }.to_h)
+        # rubocop:enable Style/HashTransformValues
+      when Array
+        obj.map {|o| to_ostruct(o) }
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/yandex360/objects/types.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class AllowList < Object; end
+  class Department < Object; end
+  class Group < Object; end
+  class User < Object; end
+  class UserList < Object; end
+
+  class DeletedDepartment < Object; end
+  class DeletedGroup < Object; end
+  class DeletedUser < Object; end
+  class DepartmentAlias < Object; end
+  class DepartmentList < Object; end
+  class DeletedDepartmentAlias < Object; end
+
+  class GroupList < Object; end
+
+  class Alias < Object; end
+end

data/lib/yandex360/resource.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+    alias delete_request delete
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Your request was malformed. #{response.body['error']}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body['error']}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body['error']}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body['error']}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body['error']}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body['error']}"
+      when 503
+        raise Error, "You have been rate limited for sending more  requests per second. #{response.body['error']}"
+      end
+
+      response
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/yandex360/resources/antispam.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class AntispamResource < Resource
+    def list(org_id:)
+      AllowList.new get("/admin/v1/org/#{org_id}/mail/antispam/allowlist/ips").body
+    end
+
+    def create(org_id, *strings)
+      body = {allowList: strings}
+      AllowList.new post("admin/v1/org/#{org_id}/mail/antispam/allowlist/ips", body: body).body
+    end
+
+    def delete(org_id:)
+      delete_request("admin/v1/org/#{org_id}/mail/antispam/allowlist/ips")
+    end
+  end
+end

data/lib/yandex360/resources/departments.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class DepartmentsResource < Resource
+    def add_alias(org_id:, dep_id:, name:)
+      dep_alias = {alias: name}
+      DepartmentAlias.new post("directory/v1/org/#{org_id}/departments/#{dep_id}/aliases", body: dep_alias).body
+    end
+
+    def update(org_id:, dep_id:, parent_id:, **params)
+      department = {
+        orgId: org_id,
+        departmentId: dep_id,
+        parentId: parent_id
+      }
+      params.each {|param, value| department[param] = value }
+      Department.new patch("directory/v1/org/#{org_id}/departments/#{dep_id}", body: department).body
+    end
+
+    def info(org_id:, dep_id:)
+      Department.new get("directory/v1/org/#{org_id}/departments/#{dep_id}").body
+    end
+
+    def list(org_id:, page: 1, per_page: 10, parent_id: 0, order_by: "id")
+      resp = get("directory/v1/org/#{org_id}/departments \
+                  ?page=#{page} \
+                  &perPage=#{per_page} \
+                  &parentId=#{parent_id} \
+                  &orderBy=#{order_by}".gsub(/\s+/, "").strip)
+      Collection.from_response(resp, key: "departments", type: Department)
+    end
+
+    # parent_id:, name:, description: "", external_id: "", head_id: 0, label: ""
+    def create(org_id:, name:, parent_id:, **params)
+      department = {
+        parentId: parent_id,
+        name: name
+      }
+      params.each do |param, value|
+        department[param] = value
+      end
+
+      Department.new post("directory/v1/org/#{org_id}/departments", body: department).body
+    end
+
+    def delete_alias(org_id:, dep_id:, name:)
+      Object.new delete_request("directory/v1/org/#{org_id}/departments/#{dep_id}/aliases/#{name}").body
+    end
+
+    def delete(org_id:, dep_id:)
+      Object.new delete_request("directory/v1/org/#{org_id}/departments/#{dep_id}").body
+    end
+  end
+end

data/lib/yandex360/resources/groups.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class GroupsResource < Resource
+    def add_user(org_id:, group_id:, user_id:, type: "user")
+      user = {
+        id: user_id,
+        type: type
+      }
+      Group.new post("directory/v1/org/#{org_id}/groups/#{group_id}/members", body: user).body
+    end
+
+    def update(org_id:, group_id:, **user_params)
+      user = {}
+      user_params.each {|param, value| user[param] = value }
+      Group.new patch("directory/v1/org/#{org_id}/groups/#{group_id}", body: user).body
+    end
+
+    def params(org_id:, group_id:)
+      Group.new get("directory/v1/org/#{org_id}/groups/#{group_id}").body
+    end
+
+    def list(org_id:, page: 1, per_page: 10)
+      resp = get("directory/v1/org/#{org_id}/groups?page=#{page}&perPage=#{per_page}")
+      Collection.from_response(resp, key: "groups", type: Group)
+    end
+
+    def users(org_id:, group_id:)
+      resp = get("directory/v1/org/#{org_id}/groups/#{group_id}/members")
+      Collection.from_response(resp, key: "users", type: User)
+    end
+
+    def create(org_id:, name:, **group_params)
+      group = {
+        name: name
+      }
+      group_params.each {|param, value| group[param] = value }
+      Group.new post("directory/v1/org/#{org_id}/groups", body: group).body
+    end
+
+    def delete(org_id:, group_id:)
+      Group.new delete_request("directory/v1/org/#{org_id}/groups/#{group_id}").body
+    end
+
+    def delete_user(org_id:, group_id:, type:, user_id:)
+      Object.new delete_request("directory/v1/org/#{org_id}/groups/#{group_id}/members/#{type}/#{user_id}").body
+    end
+  end
+end

data/lib/yandex360/resources/users.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Yandex360
+  class UsersResource < Resource
+    def add(org_id:, dep_id:, **user_params)
+      user = {
+        departmentId: dep_id
+      }
+      user_params.each {|param, value| user[param] = value }
+
+      User.new post("directory/v1/org/#{org_id}/users", body: user).body
+    end
+
+    def add_alias(org_id:, user_id:, user_alias:)
+      body = {alias: user_alias}
+      User.new post("directory/v1/org/#{org_id}/users/#{user_id}/aliases", body: body).body
+    end
+
+    def update(org_id:, user_id:, **user_params)
+      user = {}
+      user_params.each {|param, value| user[param] = value }
+
+      User.new patch("directory/v1/org/#{org_id}/users/#{user_id}", body: user).body
+    end
+
+    def info(org_id:, user_id:)
+      User.new get("directory/v1/org/#{org_id}/users/#{user_id}").body
+    end
+
+    def list(org_id:, page: 1, per_page: 10)
+      resp = get("directory/v1/org/#{org_id}/users?page=#{page}&perPage=#{per_page}")
+      Collection.from_response(resp, key: "users", type: User)
+    end
+
+    # rubocop:disable Naming/MethodName
+    def get2FA(org_id:, user_id:)
+      # TODO: add User2FA.new type
+      Object.new get("directory/v1/org/#{org_id}/users/#{user_id}/2fa").body
+    end
+
+    def has2FA?(org_id:, user_id:)
+      get2FA(org_id: org_id, user_id: user_id).has2fa
+    end
+    # rubocop:enable Naming/MethodName
+
+    def delete_alias(org_id:, user_id:, user_alias:)
+      Alias.new delete_request("directory/v1/org/#{org_id}/users/#{user_id}/aliases/#{user_alias}").body
+    end
+  end
+end

data/lib/yandex360/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Yandex360
-  major = 0
-  minor = 0
-  patch = 1
+  major = 1
+  minor = 1
+  patch = 0
   VERSION = "#{major}.#{minor}.#{patch}"
 end

data/lib/yandex360.rb

@@ -2,9 +2,30 @@
 
 require "addressable/uri"
 require "faraday"
-require "faraday_middleware"
 require "yandex360/version"
 
-module Yadisk
+module Yandex360
   autoload :Client, "yandex360/client"
+  autoload :Object, "yandex360/object"
+  autoload :Resource, "yandex360/resource"
+  autoload :Collection, "yandex360/collection"
+  autoload :Error, "yandex360/error"
+
+  autoload :AntispamResource, "yandex360/resources/antispam"
+  autoload :AllowList, "yandex360/objects/types"
+
+  autoload :DepartmentsResource, "yandex360/resources/departments"
+  autoload :Department, "yandex360/objects/types"
+  autoload :Departments, "yandex360/objects/types"
+  autoload :DepartmentList, "yandex360/objects/types"
+  autoload :DepartmentAlias, "yandex360/objects/types"
+  autoload :DeletedDepartment, "yandex360/objects/types"
+  autoload :DeletedDepartmentAlias, "yandex360/objects/types"
+
+  autoload :GroupsResource, "yandex360/resources/groups"
+  autoload :Group, "yandex360/objects/types"
+  autoload :GroupList, "yandex360/objects/types"
+
+  autoload :UsersResource, "yandex360/resources/users"
+  autoload :User, "yandex360/objects/types"
 end