yandex360 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a5a0d2ac0b76df152ea5246600c6c01469a7f5716970f2db2e10af22d5ca322
-  data.tar.gz: 3d0b28a3871390e29479f34b56eaa7637c3a0a6e98f25fc57982e9e6eaf5f540
+  metadata.gz: 66eac1024d498386e562d1ba1813ccd7992ca5a655798c35c2ceb31b9b577e32
+  data.tar.gz: 100f12e93db7cd960ca3ef04a206dcb71de80db74fab1ffd4c0db2ed73d71532
 SHA512:
-  metadata.gz: 05a2ba164cb6e206081d718505eb62df6c1ef032815e7f1b7d76d809a64026bcd2c91faeeccb0af78a77d4f2140af030d455b10f2447bada3e910a86b86565e5
-  data.tar.gz: b03c6852ea6c5b5f87d869412e834a12156422b3dd4adcb36c75c5f534df2adfb3565a29869dfd3cbb71c4a5281641a0cf560711d29abe33a12542244c9572cc
+  metadata.gz: 3f73c6450cf570a6414dec1b1f87317565df27d46352ffa8f04d03a664940efd605148cda51a1e2cd8d1d8f791ad1edca712d2b1da6a44595842ff3cc3f4637f
+  data.tar.gz: 4ca5dd21ddeeb96dbf342e18b91f16f51a0ee0a084fd09550f030c65be7eb5dbefcafe057b7f90dbea382b0655d4d78c95715afc9b4656fde26175450baf9711

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

@@ -36,3 +36,5 @@ build/
 ## macos
 .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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yandex360 (1.0.1)
+    yandex360 (1.1.1)
       addressable (~> 2.3, >= 2.3.7)
       faraday (~> 1.7)
 
@@ -10,6 +10,10 @@ GEM
   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)
@@ -33,14 +37,49 @@ GEM
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
+    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,7 +1,75 @@
-# 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)
+[![Ruby specs](https://github.com/ruby-api-client/yandex360/actions/workflows/ci.yml/badge.svg)](https://github.com/ruby-api-client/yandex360/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/ruby-api-client/yandex360/badge.svg?branch=main)](https://coveralls.io/github/ruby-api-client/yandex360?branch=main)
+
+## Installation
+
+### Gemfile
+
+```gemfile
+gem 'yandex360', '~> 1.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
 
-- reamde
+- examples
 - documentation
-- tests
+- ~~tests~~

data/lib/yandex360/resources/departments.rb

@@ -7,8 +7,12 @@ module Yandex360
       DepartmentAlias.new post("directory/v1/org/#{org_id}/departments/#{dep_id}/aliases", body: dep_alias).body
     end
 
-    def update(org_id:, dep_id:, **params)
-      department = {}
+    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
@@ -18,14 +22,12 @@ module Yandex360
     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: GroupList)
+      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: ""

data/lib/yandex360/resources/groups.rb

@@ -2,9 +2,9 @@
 
 module Yandex360
   class GroupsResource < Resource
-    def add_user(org_id:, group_id:, id:, type: "user")
+    def add_user(org_id:, group_id:, user_id:, type: "user")
       user = {
-        id: id,
+        id: user_id,
         type: type
       }
       Group.new post("directory/v1/org/#{org_id}/groups/#{group_id}/members", body: user).body
@@ -22,26 +22,28 @@ module Yandex360
 
     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: Object)
+      Collection.from_response(resp, key: "groups", type: Group)
     end
 
     def users(org_id:, group_id:)
-      # TODO: GroupUserList.new type
-      Object.new get("directory/v1/org/#{org_id}/groups/#{group_id}/members").body
+      resp = get("directory/v1/org/#{org_id}/groups/#{group_id}/members")
+      Collection.from_response(resp, key: "users", type: User)
     end
 
-    def create(org_id:, **group_params)
-      group = {}
+    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:)
-      delete_request("directory/v1/org/#{org_id}/groups/#{group_id}")
+      Group.new delete_request("directory/v1/org/#{org_id}/groups/#{group_id}").body
     end
 
-    def delete_user(org_id:, group_id:, type:, id:)
-      Object.new delete_request("directory/v1/org/#{org_id}/groups/#{group_id}/members/#{type}/#{id}").body
+    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

@@ -29,7 +29,7 @@ module Yandex360
 
     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: UserList)
+      Collection.from_response(resp, key: "users", type: User)
     end
 
     # rubocop:disable Naming/MethodName
@@ -44,7 +44,7 @@ module Yandex360
     # 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}")
+      Alias.new delete_request("directory/v1/org/#{org_id}/users/#{user_id}/aliases/#{user_alias}").body
     end
   end
 end

data/lib/yandex360/version.rb

@@ -2,7 +2,7 @@
 
 module Yandex360
   major = 1
-  minor = 0
+  minor = 1
   patch = 1
   VERSION = "#{major}.#{minor}.#{patch}"
 end

data/lib/yandex360.rb

@@ -15,6 +15,7 @@ module Yandex360
   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"
@@ -26,5 +27,5 @@ module Yandex360
   autoload :GroupList, "yandex360/objects/types"
 
   autoload :UsersResource, "yandex360/resources/users"
-  autoload :UserList, "yandex360/objects/types"
+  autoload :User, "yandex360/objects/types"
 end

data/spec/antispam_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "yandex360"
+
+RSpec.describe "#anispam.create" do
+  let(:org_id) { "1234567" }
+
+  context "when create" do
+    subject(:resp) do
+      VCR.use_cassette("anispam/create") do
+        @yandex360.antispam.create(org_id, "127.0.0.1", "172.0.1.10")
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::AllowList }
+  end
+end
+
+RSpec.describe "#anispam.list" do
+  let(:org_id) { "1234567" }
+
+  context "when list" do
+    subject(:resp) do
+      VCR.use_cassette("anispam/list") do
+        @yandex360.antispam.list(org_id: org_id)
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::AllowList }
+  end
+end
+
+RSpec.describe "#anispam.delete" do
+  let(:org_id) { "1234567" }
+
+  context "when delete" do
+    subject(:resp) do
+      VCR.use_cassette("anispam/delete") do
+        @yandex360.antispam.delete(org_id: org_id)
+      end
+    end
+
+    it { expect(resp.status).to eq 200 }
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "yandex360"
+
+RSpec.describe Yandex360::Client do
+  describe "#client", :vcr do
+    context "with valid token" do
+      it do
+        allow(described_class).to receive(:new)
+          .with(token: ACCESS_TOKEN)
+          .and_return(Yandex360::Client)
+      end
+    end
+
+    context "without token" do
+      it { expect { described_class.new }.to raise_error(ArgumentError) }
+    end
+  end
+end
+
+RSpec.describe "#VERSION" do
+  it { expect(Yandex360::VERSION).to eq "1.1.0" }
+end

data/spec/departments_spec.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "yandex360"
+
+RSpec.describe "#departments.list" do
+  let(:org_id) { "1234567" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("departments/list") do
+        @yandex360.departments.list(org_id: org_id)
+      end
+    end
+
+    it { expect(resp).to be_a Yandex360::Collection }
+    it { expect(resp.data.first).to be_an Yandex360::Department }
+  end
+end
+
+RSpec.describe "#departments.create" do
+  let(:org_id) { "1234567" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("departments/create") do
+        @yandex360.departments.create(org_id: org_id, name: "Support", parent_id: 1)
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Department }
+  end
+end
+
+RSpec.describe "#departments.update" do
+  let(:org_id) { "1234567" }
+  let(:dep_id) { "13" }
+  let(:parent_id) { "1" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("departments/update") do
+        @yandex360.departments.update(
+          org_id: org_id,
+          dep_id: dep_id,
+          parent_id: parent_id,
+          description: "Yandex360",
+          name: "Support Team",
+          label: "support-team"
+        )
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Department }
+  end
+end
+
+RSpec.describe "#departments.info" do
+  let(:org_id) { "1234567" }
+  let(:dep_id) { "13" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("departments/info") do
+        @yandex360.departments.info(dep_id: dep_id, org_id: org_id)
+      end
+    end
+
+    it { expect(resp).to be_an(Yandex360::Department) }
+  end
+end
+
+RSpec.describe "#departments.add_alias" do
+  let(:org_id) { "1234567" }
+  let(:dep_id) { "13" }
+  let(:name)   { "support-team" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("departments/add_alias") do
+        @yandex360.departments.add_alias(org_id: org_id, dep_id: dep_id, name: name)
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::DepartmentAlias }
+    it { expect(resp.aliases.first).to eq name }
+  end
+end
+
+RSpec.describe "#departments.delete_alias" do
+  let(:org_id) { "1234567" }
+  let(:dep_id) { "13" }
+  let(:name)   { "support-team" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("departments/delete_alias") do
+        @yandex360.departments.delete_alias(org_id: org_id, dep_id: dep_id, name: name)
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Object }
+    it { expect(resp.removed).to be true }
+    it { expect(resp.alias).to eq name }
+  end
+end
+
+RSpec.describe "#departments.delete" do
+  let(:org_id) { "1234567" }
+  let(:dep_id) { "13" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("departments/delete") do
+        @yandex360.departments.delete(org_id: org_id, dep_id: dep_id)
+      end
+    end
+
+    it { expect(resp).to be_an(Yandex360::Object) }
+  end
+
+  context "with error" do
+    subject(:resp) do
+      VCR.use_cassette("departments/delete_error") do
+        @yandex360.departments.delete(org_id: org_id, dep_id: dep_id)
+      end
+    end
+
+    it { expect { resp }.to raise_error(Yandex360::Error, /No results/) }
+  end
+end