yandex360 1.0.1 → 1.1.0

data/spec/groups_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "yandex360"
+
+RSpec.describe "#groups.create" do
+  let(:org_id) { "1234567" }
+  let(:name) { "Hotline" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/create") do
+        @yandex360.groups.create org_id: org_id, name: name
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Group }
+  end
+end
+
+RSpec.describe "#groups.update" do
+  let(:name) { "Hotline 247" }
+  let(:org_id) { "1234567" }
+  let(:group_id) { "19" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/update") do
+        @yandex360.groups.update org_id: org_id, group_id: group_id, name: name
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Group }
+  end
+end
+
+RSpec.describe "#groups.params" do
+  let(:org_id) { "1234567" }
+  let(:group_id) { "19" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/params") do
+        @yandex360.groups.params org_id: org_id, group_id: group_id
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Group }
+  end
+end
+
+RSpec.describe "#groups.list" do
+  let(:org_id) { "1234567" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/list") do
+        @yandex360.groups.list org_id: org_id
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Collection }
+    it { expect(resp.data.first).to be_an Yandex360::Group }
+  end
+end
+
+RSpec.describe "#groups.add_user" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "987654321" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/add_user") do
+        @yandex360.groups.add_user org_id: org_id, group_id: "19", user_id: user_id, type: "user"
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Group }
+    it { expect(resp.added).to be true }
+    it { expect(resp.id).to eq user_id }
+    it { expect(resp.type).to eq "user" }
+  end
+end
+
+RSpec.describe "#groups.users" do
+  let(:org_id) { "1234567" }
+  let(:group_id) { "19" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/users") do
+        @yandex360.groups.users org_id: org_id, group_id: group_id
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Collection }
+    it { expect(resp.data.first).to be_an Yandex360::User }
+  end
+end
+
+RSpec.describe "#groups.delete_user" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "987654321" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/delete_user") do
+        @yandex360.groups.delete_user org_id: org_id, group_id: "19", type: "user", user_id: user_id
+      end
+    end
+
+    it { expect(resp.deleted).to be true }
+    it { expect(resp.type).to eq "user" }
+    it { expect(resp.id).to eq user_id }
+  end
+end
+
+RSpec.describe "#groups.delete" do
+  let(:org_id) { "1234567" }
+  let(:group_id) { 19 }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("groups/delete") do
+        @yandex360.groups.delete org_id: org_id, group_id: group_id
+      end
+    end
+
+    it { expect(resp).to be_an Yandex360::Group }
+    it { expect(resp.removed).to eq true }
+    it { expect(resp.id).to eq group_id }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simplecov"
+require "simplecov-lcov"
+require "yandex360"
+require "webmock/rspec"
+require "vcr"
+
+SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+
+SimpleCov.start do
+  add_filter "spec/"
+  add_group "Lib", "lib"
+  minimum_coverage 80.0
+end
+
+ACCESS_TOKEN = ENV["YANDEX360_ACCESS_TOKEN"] || "SECRET_TOKEN"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    @yandex360 = Yandex360::Client.new(token: ACCESS_TOKEN)
+  end
+
+  config.example_status_persistence_file_path = ".rspec_status"
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+    c.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+VCR.configure do |c|
+  c.before_record do |i|
+    i.response.body.force_encoding("UTF-8")
+  end
+
+  c.ignore_localhost = true
+  c.cassette_library_dir = "spec/vcr"
+  c.hook_into :webmock
+
+  c.default_cassette_options = {
+    decode_compressed_response: true,
+    allow_unused_http_interactions: false
+  }
+
+  c.filter_sensitive_data("TOKEN") do |i|
+    i.request["headers"]["Authorization"].first
+  end
+
+  c.configure_rspec_metadata!
+end

data/spec/users_spec.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "yandex360"
+
+RSpec.describe "#users.list" do
+  let(:org_id) { "1234567" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/list") do
+        @yandex360.users.list(org_id: org_id)
+      end
+    end
+
+    it { expect(resp).to be_an(Yandex360::Collection) }
+    it { expect(resp.data.first).to be_an(Yandex360::User) }
+  end
+
+  context "with error" do
+    let(:org_id) { "3287461283" }
+    subject(:resp) do
+      VCR.use_cassette("users/list_error") do
+        @yandex360.users.list(org_id: org_id)
+      end
+    end
+
+    it { expect { resp }.to raise_error(Yandex360::Error, /not allowed/) }
+  end
+end
+
+RSpec.describe "#users.add" do
+  let(:org_id) { "1234567" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/add") do
+        @yandex360.users.add(
+          org_id: org_id,
+          dep_id: 1,
+          about: "Yandex360",
+          name: {
+            first: "Ivan",
+            last: "Ivanov",
+            middle: "Ruby"
+          },
+          nickname: "yandex360",
+          password: "W!846f456678"
+        )
+      end
+    end
+    it { expect(resp).to be_an(Yandex360::User) }
+    it { expect(resp.name.first).to eq "Ivan" }
+    it { expect(resp.about).to eq "Yandex360" }
+  end
+end
+
+RSpec.describe "#users.update" do
+  let(:user_id) { "1130000061922106" }
+  let(:org_id)  { "1234567" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/update") do
+        @yandex360.users.update(
+          org_id: org_id,
+          user_id: user_id,
+          about: "Yandex360 - Ruby API gem",
+          name: {
+            first: "Ruby",
+            last: "gem",
+            middle: "API"
+          },
+          nickname: "yandex360-ruby-api-client",
+          password: "passswrrdwithstrrngscrrty"
+        )
+      end
+    end
+    it { expect(resp).to be_an(Yandex360::User) }
+    it { expect(resp.id).to eq user_id }
+    it { expect(resp.name.first).to eq "Ruby" }
+    it { expect(resp.about).to eq "Yandex360 - Ruby API gem" }
+  end
+end
+
+RSpec.describe "#users.add_alias" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "1130000018743049" }
+  let(:user_alias) { "ruby_gem_api" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/add_alias") do
+        @yandex360.users.add_alias org_id: org_id, user_id: user_id, user_alias: user_alias
+      end
+    end
+
+    it { expect(resp).to be_an(Yandex360::User) }
+    it { expect(resp.aliases.first).to eq user_alias }
+  end
+end
+
+RSpec.describe "#users.delete_alias" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "1130000018743049" }
+  let(:user_alias) { "ruby_gem_api" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/delete_alias") do
+        @yandex360.users.delete_alias org_id: org_id, user_id: user_id, user_alias: user_alias
+      end
+    end
+
+    it { expect(resp).to be_an(Yandex360::Alias) }
+    it { expect(resp.alias).to eq user_alias }
+    it { expect(resp.removed).to be(true) }
+  end
+end
+
+RSpec.describe "#users.has2FA" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "1130000018743049" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/has2FA") do
+        @yandex360.users.has2FA? org_id: org_id, user_id: user_id
+      end
+    end
+
+    it { expect(resp).to be(true).or be(false) }
+  end
+end
+
+RSpec.describe "#users.get2FA" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "1130000018743049" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/get2FA") do
+        @yandex360.users.get2FA(org_id: org_id, user_id: user_id)
+      end
+    end
+
+    it { expect(resp).to be_an(Yandex360::Object) }
+    it { expect(resp.userId).to eq(user_id) }
+    it { expect(resp.has2fa).to be(true).or be(false) }
+  end
+
+  context "with error" do
+    subject(:resp) do
+      VCR.use_cassette("users/get2FA_error") do
+        @yandex360.users.get2FA(org_id: 123, user_id: 123)
+      end
+    end
+
+    it { expect { resp }.to raise_error(Yandex360::Error, /not allowed/) }
+  end
+end
+
+RSpec.describe "#users.has2FA" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "1130000018743049" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/has2FA") do
+        @yandex360.users.has2FA? org_id: org_id, user_id: user_id
+      end
+    end
+
+    it { expect(resp).to be(true).or be(false) }
+  end
+end
+
+RSpec.describe "#users.info" do
+  let(:org_id) { "1234567" }
+  let(:user_id) { "987654321" }
+
+  context "with params" do
+    subject(:resp) do
+      VCR.use_cassette("users/info") do
+        @yandex360.users.info(org_id: org_id, user_id: user_id)
+      end
+    end
+
+    it { expect(resp).to be_an(Yandex360::User) }
+    it { expect(resp.name).to be_an(OpenStruct) }
+    it { expect(resp.contacts).to be_an(Array) }
+  end
+
+  context "without params" do
+    subject(:resp) do
+      VCR.use_cassette("users_info") do
+        @yandex360.users.info
+      end
+    end
+
+    it { expect { resp }.to raise_error(ArgumentError) }
+  end
+end

data/spec/vcr/anispam/create.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api360.yandex.net/admin/v1/org/1234567/mail/antispam/allowlist/ips
+    body:
+      encoding: UTF-8
+      string: '{"allowList":["127.0.0.1","172.0.1.10"]}'
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - TOKEN
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Sat, 15 Oct 2022 11:29:15 GMT
+      Grpc-Status:
+      - '0'
+      Grpc-Message:
+      - OK
+      Content-Length:
+      - '2'
+      Server:
+      - api360
+      X-Request-Id:
+      - '09887e4f-02dc-4fc0-aac9-4cfdb5ccf8e6'
+    body:
+      encoding: UTF-8
+      string: "{}"
+  recorded_at: Sat, 15 Oct 2022 11:29:15 GMT
+recorded_with: VCR 6.1.0

data/spec/vcr/anispam/delete.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api360.yandex.net/admin/v1/org/1234567/mail/antispam/allowlist/ips
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Sat, 15 Oct 2022 11:30:51 GMT
+      Grpc-Status:
+      - '0'
+      Grpc-Message:
+      - OK
+      Content-Length:
+      - '2'
+      Server:
+      - api360
+      X-Request-Id:
+      - 56193e69-ff82-42e7-8770-d24c1fddd07f
+    body:
+      encoding: UTF-8
+      string: "{}"
+  recorded_at: Sat, 15 Oct 2022 11:30:51 GMT
+recorded_with: VCR 6.1.0

data/spec/vcr/anispam/list.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api360.yandex.net/admin/v1/org/1234567/mail/antispam/allowlist/ips
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Sat, 15 Oct 2022 11:29:15 GMT
+      Grpc-Status:
+      - '0'
+      Grpc-Message:
+      - OK
+      Content-Length:
+      - '40'
+      Server:
+      - api360
+      X-Request-Id:
+      - d51ba76c-429d-4e9b-920c-0e34ba77f461
+    body:
+      encoding: UTF-8
+      string: '{"allowList":["127.0.0.1","172.0.1.10"]}'
+  recorded_at: Sat, 15 Oct 2022 11:29:15 GMT
+recorded_with: VCR 6.1.0

data/spec/vcr/departments/add_alias.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api360.yandex.net/directory/v1/org/1234567/departments/13/aliases
+    body:
+      encoding: UTF-8
+      string: '{"alias":"support-team"}'
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - TOKEN
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 14 Oct 2022 12:23:15 GMT
+      Grpc-Status:
+      - '0'
+      Grpc-Message:
+      - OK
+      Content-Length:
+      - '240'
+      Server:
+      - api360
+      X-Request-Id:
+      - 78978203-a92f-4b6c-9c30-f8a60f4bdad9
+    body:
+      encoding: UTF-8
+      string: '{"id":13,"name":"Support Team","parentId":1,"description":"Yandex360","externalId":"","label":"support-team","email":"support-team@example.ru","headId":"0","membersCount":0,"aliases":["support-team"],"createdAt":"2022-10-14T12:23:13.909Z"}'
+  recorded_at: Fri, 14 Oct 2022 12:23:16 GMT
+recorded_with: VCR 6.1.0

data/spec/vcr/departments/create.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api360.yandex.net/directory/v1/org/1234567/departments
+    body:
+      encoding: UTF-8
+      string: '{"parentId":1,"name":"Support"}'
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - TOKEN
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 14 Oct 2022 12:23:14 GMT
+      Grpc-Status:
+      - '0'
+      Grpc-Message:
+      - OK
+      Content-Length:
+      - '176'
+      Server:
+      - api360
+      X-Request-Id:
+      - 84738e03-3b04-4459-ac42-20ae8e3814bb
+    body:
+      encoding: UTF-8
+      string: '{"id":13,"name":"Support","parentId":1,"description":"","externalId":"","label":"","email":"","headId":"0","membersCount":0,"aliases":[],"createdAt":"2022-10-14T12:23:13.909Z"}'
+  recorded_at: Fri, 14 Oct 2022 12:23:14 GMT
+recorded_with: VCR 6.1.0

data/spec/vcr/departments/delete.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api360.yandex.net/directory/v1/org/1234567/departments/13
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 14 Oct 2022 12:23:17 GMT
+      Grpc-Status:
+      - '0'
+      Grpc-Message:
+      - OK
+      Content-Length:
+      - '24'
+      Server:
+      - api360
+      X-Request-Id:
+      - c178cb13-7678-4eb2-8ba4-d79b6c310008
+    body:
+      encoding: UTF-8
+      string: '{"id":13,"removed":true}'
+  recorded_at: Fri, 14 Oct 2022 12:23:17 GMT
+recorded_with: VCR 6.1.0

data/spec/vcr/departments/delete_alias.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api360.yandex.net/directory/v1/org/1234567/departments/13/aliases/support-team
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 14 Oct 2022 12:23:16 GMT
+      Grpc-Status:
+      - '0'
+      Grpc-Message:
+      - OK
+      Content-Length:
+      - '39'
+      Server:
+      - api360
+      X-Request-Id:
+      - 41abba20-602a-4a9e-94fe-ced93fd801cb
+    body:
+      encoding: UTF-8
+      string: '{"alias":"support-team","removed":true}'
+  recorded_at: Fri, 14 Oct 2022 12:23:16 GMT
+recorded_with: VCR 6.1.0