1c-connect-api-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0915e21537f0dacafdde45e926a8b6f20c0d8ece62b557141161a474b3ce43ef'
+  data.tar.gz: b5957ac9238cffa629240877b828af9cdf0ba961f5683b2b5b6cb23b91bd2809
+SHA512:
+  metadata.gz: 433bc378ec6c7fa2147050023af815157e29d9ab937a408da2ad3b8eb95d4a934d3a67e472bc2765a179fc9ed427ef7addb7b74d83ecdfc83b251c90293fce4e
+  data.tar.gz: 797e400fe40072d8a8c882e3c4dfbd68316b8383626c63b9c17238237063e1faec00974c48e772ba56efe1fdac1b71d51cff596c8712624bf4b5f2940187a46f

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '3.2.2' ]
+    env:
+      CONNECT_LOGIN: "login"
+      CONNECT_PASSWORD: "password"
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1 @@
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--warnings

data/.rubocop.yaml

@@ -0,0 +1,29 @@
+---
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  AllowedMethods:
+    - context
+    - describe
+    - task
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'faraday'
+gem 'savon', '~> 2.13.0'
+gem 'rake', '~> 13.0'
+group :test do
+  gem 'rspec', '~> 3.4'
+  gem 'vcr', '~> 6.0'
+  gem 'webmock', '~> 3.18.1'
+end
+
+group :development do
+  gem 'dotenv', '~> 2.8'
+  gem 'rubocop', '~> 1.54.1'
+  gem 'rubocop-performance', '~> 1.18'
+  gem 'rubocop-rake', '~> 0.6.0'
+  gem 'rubocop-rspec', '~> 2.22.0'
+end

data/Gemfile.lock

@@ -0,0 +1,148 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    akami (1.3.3)
+      base64
+      gyoku (>= 0.4.0)
+      nokogiri
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    date (3.3.4)
+    diff-lcs (1.5.1)
+    dotenv (2.8.1)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    gyoku (1.4.0)
+      builder (>= 2.1.2)
+      rexml (~> 3.0)
+    hashdiff (1.1.0)
+    httpi (3.0.2)
+      base64
+      mutex_m
+      nkf
+      rack (< 3)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    mini_mime (1.1.5)
+    mutex_m (0.2.0)
+    net-imap (0.4.10)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nkf (0.2.0)
+    nokogiri (1.16.2-x64-mingw-ucrt)
+      racc (~> 1.4)
+    nori (2.7.0)
+      bigdecimal
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (2.2.8.1)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.54.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    savon (2.13.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (>= 2.4.5)
+      mail (~> 2.5)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    timeout (0.4.1)
+    unicode-display_width (2.5.0)
+    vcr (6.2.0)
+    wasabi (3.8.0)
+      addressable
+      httpi (~> 3.0)
+      nokogiri (>= 1.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x64-mingw-ucrt
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv (~> 2.8)
+  faraday
+  rake (~> 13.0)
+  rspec (~> 3.4)
+  rubocop (~> 1.54.1)
+  rubocop-performance (~> 1.18)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.22.0)
+  savon (~> 2.13.0)
+  vcr (~> 6.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.5.6

data/lib/connect/http_service/bot_api.rb

@@ -0,0 +1,71 @@
+module Connect
+  module HTTPService
+    module BotApi
+      include Connect::HTTPService::Request
+
+      def appoint_start(options)
+        post(
+          'v1/line/appoint/start',
+          self,
+          options
+        )
+      end
+
+      def appoint_spec(options)
+        post(
+          'v1/line/appoint/spec',
+          self,
+          options
+        )
+      end
+
+      def drop_treatment(options)
+        post(
+          'v1/line/drop/treatment',
+          self,
+          options
+        )
+      end
+
+      def send_message_line(options)
+        post(
+          'v1/line/send/message',
+          self,
+          options
+        )
+      end
+
+      def send_message_line(options)
+        post(
+          'v1/line/send/message',
+          self,
+          options
+        )
+      end
+
+      def drop_keyboard(options)
+        post(
+          'v1/line/drop/keyboard',
+          self,
+          options
+        )
+      end
+
+      def send_message_colleague(options)
+        post(
+          'v1/colleague/send/message',
+          self,
+          options
+        )
+      end
+
+      def send_message_conference(options)
+        post(
+          'v1/conference/send/message',
+          self,
+          options
+        )
+      end
+    end
+  end
+end

data/lib/connect/http_service/client.rb

@@ -0,0 +1,14 @@
+module Connect
+  module HTTPService
+    class Client
+      include Connect::HTTPService::Rest
+
+      attr_reader :login, :password
+
+      def initialize(options)
+        @login = options[:login]
+        @password = options[:password]
+      end
+    end
+  end
+end

data/lib/connect/http_service/connection.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Connect
+  module HTTPService
+    module Connection
+      BASE_URL = 'https://push.1c-connect.com/'
+
+      def connection(client)
+        Faraday.new(options) do |faraday|
+          faraday.request :authorization, :basic, client.login, client.password
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      private
+
+      def options
+        {
+          headers: {
+            'content-type': 'application/json'
+          },
+          url: BASE_URL
+        }
+      end
+    end
+  end
+end

data/lib/connect/http_service/information_api.rb

@@ -0,0 +1,88 @@
+module Connect
+  module HTTPService
+    module InformationApi
+      include Connect::HTTPService::Request
+      
+      def get_treatments(options = {})
+        get(
+          'v1/line/treatment/',
+          self,
+          options
+        )
+      end
+
+      def get_subscriber(options)
+        get(
+          "v1/line/subscriber/#{options[:user_id]}",
+          self
+        )
+      end
+
+      def get_subscribers
+        get(
+          'v1/line/subscribers',
+          self
+        )
+      end
+
+      def get_subscriptions(options)
+        get(
+          'v1/line/subscriptions',
+          self,
+          options
+        )
+      end
+
+      def get_lines
+        get(
+          'v1/line',
+          self
+        )
+      end
+
+      def get_specialist(options)
+        get(
+          "v1/line/specialist/#{options[:user_id]}",
+          self
+        )
+      end
+
+      def get_specialists
+        get(
+          'v1/line/specialists',
+          self
+        )
+      end
+
+      def get_specialists_available(options)
+        get(
+          "v1/line/specialists/#{options[:line_id]}/available",
+          self,
+          options
+        )
+      end
+
+      def get_competences(options = {})
+        get(
+          "v1/line/competences",
+          self,
+          options
+        )
+      end
+
+      def get_ticket(options)
+        get(
+          "v1/ticket/#{options[:id]}",
+          self
+        )
+      end
+
+      def get_ticket_by_number(options)
+        get(
+          "v1/ticket/number/#{options[:number]}",
+          self
+        )
+      end
+    end
+  end
+end

data/lib/connect/http_service/request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Connect
+  module HTTPService
+    module Request
+      include Connect::HTTPService::Connection
+
+      def get(path, client, params = {})
+        respond_with(connection(client).get(path, params))
+      end
+
+      def post(path, client, params = {}, files = {})
+        respond_with(connection(client).post(path, JSON.dump(params)))
+      end
+
+      private
+
+      def respond_with(response)
+        begin
+          JSON.parse(response.body)
+        rescue
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/connect/http_service/rest.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Connect
+  module HTTPService
+    module Rest
+      include Connect::HTTPService::InformationApi
+      include Connect::HTTPService::BotApi
+    end
+  end
+end

data/lib/connect/http_service.rb

@@ -0,0 +1,7 @@
+require 'faraday'
+require_relative 'http_service/connection'
+require_relative 'http_service/request'
+require_relative 'http_service/information_api'
+require_relative 'http_service/bot_api'
+require_relative 'http_service/rest'
+require_relative 'http_service/client'

data/lib/connect/web_service/client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    class Client
+      include Connect::WebService::Connection
+      include Connect::WebService::Rest
+
+      attr_reader :login, :password, :connection
+
+      def initialize(options)
+        @login = options[:login]
+        @password = options[:password]
+        @connection = create_connection(self)
+      end
+    end
+  end
+end

data/lib/connect/web_service/connect_parameters/connect_parameter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module ConnectParameters
+      class ConnectParameter
+        attr_accessor :property, :value, :required
+
+        def initialize(property, value, required = false)
+          @property = property
+          @value = value
+          @required = required
+        end
+      end
+    end
+  end
+end

data/lib/connect/web_service/connect_parameters/connect_property.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module ConnectParameters
+      class ConnectProperty
+        attr_accessor :xmlns, :name
+
+        def initialize(name)
+          @xmlns = 'http://v8.1c.ru/8.1/data/core'
+          @name = name
+        end
+      end
+    end
+  end
+end

data/lib/connect/web_service/connect_parameters/connect_value.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module ConnectParameters
+      class ConnectValue
+        attr_accessor :type, :content
+
+        def initialize(type, content)
+          @type = type
+          @content = content
+        end
+      end
+    end
+  end
+end

data/lib/connect/web_service/connect_parameters/params_factory.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module ConnectParameters
+      module ParamsFactory
+        def create_parameter(options)
+          property = ConnectProperty.new(options[:name])
+          value = ConnectValue.new(options[:type], options[:content])
+          ConnectParameter.new(property, value)
+        end
+
+        def create_changed_from(options)
+          date = options[:changed_from]
+          content = nil
+          if date
+            content = date.strftime('%Y-%m-%dT%H:%M:%S')
+          end
+          create_date_time(
+            name: 'ChangedFrom',
+            content: content
+          )
+        end
+
+        def create_date_time(options)
+          create_parameter(
+            name: options[:name],
+            type: 'xs:dateTime',
+            content: options[:content]
+          )
+        end
+
+        def create_string(options)
+          create_parameter(
+            name: options[:name],
+            type: 'xs:string',
+            content: options[:content]
+          )
+        end
+
+        def create_date(options)
+          create_parameter(
+            name: options[:name],
+            type: 'xs:date',
+            content: options[:content]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/connect/web_service/connect_parameters/params_serializer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module ConnectParameters
+      class ParamsSerializer
+        def initialize(params)
+          @params = params
+          @xml = Builder::XmlMarkup.new
+        end
+
+        def serialize
+          @xml.par(:Params) do
+            @params.each do |param|
+              property = param.property
+              value = param.value
+              @xml.Property('xmlns' => property.xmlns, 'name' => property.name) do
+                @xml.Value(value.content, 'xsi:type' => value.type)
+              end
+            end
+          end
+          @xml.target!
+        end
+      end
+    end
+  end
+end

data/lib/connect/web_service/connect_parameters.rb

@@ -0,0 +1,5 @@
+require_relative 'connect_parameters/connect_parameter'
+require_relative 'connect_parameters/connect_property'
+require_relative 'connect_parameters/connect_value'
+require_relative 'connect_parameters/params_serializer'
+require_relative 'connect_parameters/params_factory'

data/lib/connect/web_service/connection.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module Connection
+      def create_connection(client)
+        auth_data = [client.login, client.password]
+        Savon.client(
+          wsdl: 'https://cus.1c-connect.com/cus/ws/PartnerWebAPI2?wsdl',
+          basic_auth: auth_data
+        )
+      end
+    end
+  end
+end

data/lib/connect/web_service/request.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module Request
+      def call(client, options)
+        request_params = []
+        request_params = options[:params] if options[:params]
+        method = options[:method]
+        method_as_s = method.to_s
+        camel_case_method_name = method_as_s.to_s.gsub(/(?:_|\b)([a-z])/) { $1.upcase }
+        xml_body = build_params(camel_case_method_name, request_params)
+        xml = xml_template(xml_body)
+        response = client.connection.call(method, xml: xml)
+        body = response.body
+        body_key = "#{method_as_s}_response".to_sym
+        response_data = []
+        if (property = body.dig(body_key, :return, :property)) && property.size > 1 && property[1][:value][:row]
+          response_data = property[1][:value][:row]
+        end
+        response_data
+      end
+
+      private
+
+      def build_params(name, params = [])
+        serializer = Connect::WebService::ConnectParameters::ParamsSerializer.new(params)
+        params = serializer.serialize
+        "<par:#{name}>#{params}</par:#{name}>"
+      end
+
+      def xml_template(body)
+        <<-XML
+          <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:par="http://buhphone.com/PartnerWebAPI2" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="http://v8.1c.ru/8.1/data/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+            <soap:Header/>
+            <soap:Body>
+              #{body}
+            </soap:Body>
+          </soap:Envelope>
+        XML
+      end
+    end
+  end
+end

data/lib/connect/web_service/rest.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Connect
+  module WebService
+    module Rest
+      include Connect::WebService::Request
+      include Connect::WebService::ConnectParameters::ParamsFactory
+
+      def region_read
+        call(self, method: :region_read)
+      end
+
+      def department_read(options = {})
+        params = []
+        add_param(params, create_changed_from(options))
+        call(self, method: :department_read, params: params)
+      end
+
+      def department_add(options)
+        params = []
+        add_param(params, create_string(name: 'Name', content: options[:name], required: true))
+        call(self, method: :department_add, params: params)
+      end
+
+      def department_edit(options)
+        params = []
+        add_param(params, create_string(name: 'DepartmentID', content: options[:department_id], required: true))
+        add_param(params, create_string(name: 'Name', content: options[:name]))
+        call(self, method: :department_edit, params: params)
+      end
+
+      def department_delete(options)
+        params = []
+        add_param(params, create_string(name: 'DepartmentID', content: options[:department_id], required: true))
+        call(self, method: :department_delete, params: params)
+      end
+
+      def specialist_read(options = {})
+        params = []
+        add_param(params, create_changed_from(options))
+        call(self, method: :specialist_read, params: params)
+      end
+
+      def specialist_add(options)
+        params = []
+        add_param(params, create_string(name: 'Name', content: options[:name], required: true))
+        add_param(params, create_string(name: 'email', content: options[:email], required: true))
+        add_param(params, create_string(name: 'Surname', content: options[:surname]))
+        add_param(params, create_string(name: 'SecondaryName', content: options[:secondary_name]))
+        add_param(params, create_string(name: 'Password', content: options[:password]))
+        add_param(params, create_date(name: 'Birthday', content: options[:birthday]))
+        add_param(params, create_string(name: 'Post', content: options[:post]))
+        add_param(params, create_string(name: 'DepartmentID', content: options[:department_id]))
+        add_param(params, create_string(name: 'Phone', content: options[:phone]))
+
+        call(self, method: :specialist_add, params: params)
+      end
+
+      def client_user_read(options = {})
+        params = []
+        add_param(params, create_changed_from(options))
+        add_param(params, create_string(name: 'ClientID', content: options[:client_id]))
+        call(self, method: :client_user_read, params: params)
+      end
+
+      def add_param(params, param)
+        params << param if param.required || param.value.content
+      end
+    end
+  end
+end

data/lib/connect/web_service.rb

@@ -0,0 +1,6 @@
+require 'savon'
+require_relative 'web_service/connect_parameters'
+require_relative 'web_service/connection'
+require_relative 'web_service/request'
+require_relative 'web_service/rest'
+require_relative 'web_service/client'

data/lib/connect.rb

@@ -0,0 +1,2 @@
+require_relative 'connect/web_service'
+require_relative 'connect/http_service'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: 1c-connect-api-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anatoly Busygin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-24 00:00:00.000000000 Z
+dependencies: []
+description:
+email: anatolyb94@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yaml"
+- Gemfile
+- Gemfile.lock
+- lib/connect.rb
+- lib/connect/http_service.rb
+- lib/connect/http_service/bot_api.rb
+- lib/connect/http_service/client.rb
+- lib/connect/http_service/connection.rb
+- lib/connect/http_service/information_api.rb
+- lib/connect/http_service/request.rb
+- lib/connect/http_service/rest.rb
+- lib/connect/web_service.rb
+- lib/connect/web_service/client.rb
+- lib/connect/web_service/connect_parameters.rb
+- lib/connect/web_service/connect_parameters/connect_parameter.rb
+- lib/connect/web_service/connect_parameters/connect_property.rb
+- lib/connect/web_service/connect_parameters/connect_value.rb
+- lib/connect/web_service/connect_parameters/params_factory.rb
+- lib/connect/web_service/connect_parameters/params_serializer.rb
+- lib/connect/web_service/connection.rb
+- lib/connect/web_service/request.rb
+- lib/connect/web_service/rest.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: 1C-Connect API client
+test_files: []