bitrix24_cloud_api 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 84085ace187be8919be8a75f9504323d4de260c0
-  data.tar.gz: d122f691d8b5703228acdf08c12575b89d52f6e0
+SHA256:
+  metadata.gz: b92169a6152fa854ee3bda27b04c58fd53af4d8106797b4d307ecfc8c8a6ce3e
+  data.tar.gz: 48246a7ad48ae1228cd533a45ae1c85a238170e042ad72ddb0ae6e02fdf3d033
 SHA512:
-  metadata.gz: 0e04975c75b6df639cd8ac3bb685d00e19b6ee8335f181c2cdb1e92a72492c2b63c7095cb4800e9375d8fc57c69d8442c6d38af213acbe6db7b55d330dcaffad
-  data.tar.gz: e1a79ab3a3b32bf317727afffe3e58757b0819fd008c7ae4e734992fd8ca734b584ed560b5d1c4daa259a7a49439662c27e38423083233253fd5a96d9d3e7e39
+  metadata.gz: 906d484f88507ff7ac490753c3230b11e0b9fe80855ec5a314c0c73d3683818db8ec0945a85b0a2e83a3e476f3ca7d39a92a3e0ae926eaebb9042b3acdbd9454
+  data.tar.gz: 8f1c16284be468be1be707c215aa3281e47bcf0c3a131651e23b84173a61d2719f31ad90785f94b36d48f1f9439056d8850a93e4df3ebd3933d7387b17a4e65b

data/.gitignore

@@ -7,4 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-/.idea/
+.idea/

data/README.md

@@ -1,6 +1,8 @@
+[![Build Status](https://travis-ci.org/nononoy/bitrix24_cloud_api.svg?branch=master)](https://travis-ci.org/nononoy/bitrix24_cloud_api)
+
 # Bitrix24CloudApi
 
-Ruby library for [Bitrix24 REST API](https://dev.1c-bitrix.ru/rest_help/index.php) **(only Cloud version)**.  
+Ruby library for [Bitrix24 REST API](https://dev.1c-bitrix.ru/rest_help/index.php).  
 
 ## Installation
 
@@ -48,49 +50,24 @@ To **refresh** oauth2 **access_token** use:
     
 it's response contains a hash with refreshed *oauth2 credentials*.
 
-If you already **have a valid access_token** add it to the client's attributes `@client.update(access_token: access_token)` or create a new client instance `@client = Bitrix24CloudApi::Client.new(access_token: access_token)`. 
+If you already **have a valid access_token** add it to the client's attributes `@client.update(access_token: access_token)` or create a new client instance 
+```
+@client = Bitrix24CloudApi::Client.new(access_token: access_token, endpoint: api_endpoint). 
+```
       
-### CRM
+### Aliases
+
+```
+B24 == Bitrix24CloudApi
+B24_CRM == Bitrix24CloudApi::CRM
+```
+
+So, `Bitrix24CloudApi::CRM::Lead.add(@client, params)` equals to `B24_CRM::Lead.add(@client, params)`.
+   
       
-Available models
+### CRM
 
-    * Bitrix24CloudApi::CRM::Activity
-    * Bitrix24CloudApi::CRM::ACTIVITY::Communication
-       
-    * Bitrix24CloudApi::CRM::Company
-    * Bitrix24CloudApi::CRM::COMPANY::Userfield
-    
-    * Bitrix24CloudApi::CRM::Contact
-    * Bitrix24CloudApi::CRM::CONTACT::Userfield  
-    
-    * Bitrix24CloudApi::CRM::Currency
-    * Bitrix24CloudApi::CRM::CURRENCY::Localizations  
-    
-    * Bitrix24CloudApi::CRM::Deal
-    * Bitrix24CloudApi::CRM::DEAL::Userfield  
-    * Bitrix24CloudApi::CRM::DEAL::ProductRows  
-    
-    * Bitrix24CloudApi::CRM::Lead
-    * Bitrix24CloudApi::CRM::LEAD::Userfield
-    * Bitrix24CloudApi::CRM::LEAD::ProductRows
-       
-    * Bitrix24CloudApi::CRM::Quote
-    * Bitrix24CloudApi::CRM::QUOTE::Userfield
-    * Bitrix24CloudApi::CRM::QUOTE::ProductRows
-    
-    * Bitrix24CloudApi::CRM::Localizations
-    * Bitrix24CloudApi::CRM::Product
-    * Bitrix24CloudApi::CRM::ProductRows
-    * Bitrix24CloudApi::CRM::ProductSection
-    * Bitrix24CloudApi::CRM::Userfield   
-    * Bitrix24CloudApi::CRM::Duplicate
-    * Bitrix24CloudApi::CRM::Enum
-    * Bitrix24CloudApi::CRM::Invoice
-    * Bitrix24CloudApi::CRM::InvoiceStatus    
-    * Bitrix24CloudApi::CRM::Communication
-    * Bitrix24CloudApi::CRM::Catalog     
-
-All models' metods are provided. Second attribute in method call is a hash for bitrix24 REST API query. Example:
+All REST API methods are provided. Second attribute in method call is a hash for bitrix24 REST API query. Example:
     
     params = { fields: {TITLE: title, PHONE: [VALUE: phone, VALUE_TYPE: "WORK"]} }
     Bitrix24CloudApi::CRM::Lead.add(@client, params)

data/bitrix24_cloud_api.gemspec

@@ -14,22 +14,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/nononoy/bitrix24_cloud_api"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  # end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.metadata["source_code_uri"] = "https://github.com/nononoy/bitrix24_cloud_api"
+
+  spec.add_runtime_dependency "oauth2", "~> 1.1"
+  spec.add_runtime_dependency "httparty", "~> 0.13.7"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "oauth2", "~> 1.1"
-  spec.add_development_dependency "httparty", "~> 0.13.7"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'shoulda-matchers', "~> 2.0"
 end

data/lib/bitrix24_cloud_api/CRM/activity.rb

@@ -11,6 +11,11 @@ module Bitrix24CloudApi
     end
 
     class Activity < Bitrix24CloudApi::Crm
+      [:company, :contact].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_post_request(resource_url(client, action), query)
+        end
+      end
     end
   end
 end

data/lib/bitrix24_cloud_api/CRM/additional_entities.rb

@@ -10,49 +10,89 @@ module Bitrix24CloudApi
       end
     end
 
-    class Userfield < Bitrix24CloudApi::Crm
+    class Localizations < Bitrix24CloudApi::Crm
       class << self
-        undef_method :fields
+        def set(client, query = {})
+          client.make_post_request(resource_url(client, __method__), query)
+        end
+      end
+    end
 
-        def types(client, query = {})
+    class Communication < Bitrix24CloudApi::Base
+      class << self
+        def fields(client, query = {})
           client.make_get_request(resource_url(client, __method__), query)
         end
       end
     end
 
-    class Localizations < Bitrix24CloudApi::Crm
+    class Multifield < Bitrix24CloudApi::Base
       class << self
-        undef_method :delete, :fields, :get
+        def fields(client, query = {})
+          client.make_get_request(resource_url(client, __method__), query)
+        end
+      end
+    end
 
-        def set(client, query = {})
-          client.make_post_request(resource_url(client, __method__), query)
+    class Duplicate < Bitrix24CloudApi::Base
+      [:findbycomm].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
         end
       end
     end
 
-    class Communication < Bitrix24CloudApi::Crm
-      class << self
-        undef_method :add, :delete, :update, :get, :list
+    class Stage < Bitrix24CloudApi::Base
+      [:list, :fields].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
+        end
       end
     end
 
-    class Duplicate < Bitrix24CloudApi::Crm
-      class << self
-        undef_method :add, :delete, :update, :get, :list
+    class Enum < Bitrix24CloudApi::Base
+      [:ownertype, :contenttype, :activitytype, :activitypriority, :activitydirection,
+       :activitynotifytype, :fields].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
+        end
+      end
+    end
 
-        def findbycomm(client, query = {})
+    class Settings < Bitrix24CloudApi::Base
+      class << self
+        def fields(client, query = {})
           client.make_get_request(resource_url(client, __method__), query)
         end
       end
     end
 
-    class Enum < Bitrix24CloudApi::Crm
+    class Enumeration < Bitrix24CloudApi::Base
       class << self
-        undef_method :add, :delete, :update, :get, :list
+        def fields(client, query = {})
+          client.make_get_request(resource_url(client, __method__), query)
+        end
       end
+    end
 
-      [:ownertype, :contenttype, :activitytype, :activitypriority, :activitydirection,
-       :activitynotifytype].each do |action|
+    class Paysystem < Bitrix24CloudApi::Base
+      [:list, :fields].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
+        end
+      end
+    end
+
+    class PersonType < Bitrix24CloudApi::Base
+      [:list, :fields].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
+        end
+      end
+    end
+
+    class Entity < Bitrix24CloudApi::Base
+      [:types, :items].each do |action|
         define_singleton_method(action) do |client, query = {}|
           client.make_get_request(resource_url(client, action), query)
         end

data/lib/bitrix24_cloud_api/CRM/address.rb

@@ -0,0 +1,9 @@
+module Bitrix24CloudApi
+  module CRM
+    class Address < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :get
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/deal_category.rb

@@ -0,0 +1,22 @@
+module Bitrix24CloudApi
+  module CRM
+    module DEAL_CATEGORY
+      def self.const_missing(c)
+        if c == :Stage
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.dealcategory.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
+    class DealCategory < Bitrix24CloudApi::Crm
+
+      [:status].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
+        end
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/externalchannel.rb

@@ -0,0 +1,30 @@
+module Bitrix24CloudApi
+  module CRM
+    module EXTERNALCHANNEL
+      def self.const_missing(c)
+        if c == :Activity
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.externalchannel.#{c.downcase}" }
+          target_class
+        end
+      end
+
+      class Connector < Bitrix24CloudApi::Base
+        class << self
+          def register(client, query = {})
+            client.make_post_request(resource_url(client, __method__), query)
+          end
+        end
+      end
+    end
+
+    class Externalchannel < Bitrix24CloudApi::Base
+
+      [:company, :contact].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
+        end
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/invoice.rb

@@ -1,5 +1,15 @@
 module Bitrix24CloudApi
   module CRM
+    module INVOICE
+      def self.const_missing(c)
+        if c == :Userfield
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.invoice.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
     class Invoice < Bitrix24CloudApi::Crm
     end
   end

data/lib/bitrix24_cloud_api/CRM/live_feed_message.rb

@@ -0,0 +1,11 @@
+module Bitrix24CloudApi
+  module CRM
+    class LiveFeedMessage < Bitrix24CloudApi::Base
+      class << self
+        def add(client, query = {})
+          client.make_post_request(resource_url(client, __method__), query)
+        end
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/measure.rb

@@ -0,0 +1,6 @@
+module Bitrix24CloudApi
+  module CRM
+    class Measure < Bitrix24CloudApi::Crm
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/product.rb

@@ -1,5 +1,25 @@
 module Bitrix24CloudApi
   module CRM
+    module PRODUCT
+      module PROPERTY
+        def self.const_missing(c)
+          if [:Settings, :Enumeration].any?{|x| x == c}
+            target_class = Bitrix24CloudApi::CRM.const_get(c)
+            target_class.define_singleton_method(:resource_path) { "crm.product.property.#{c.downcase}" }
+            target_class
+          end
+        end
+      end
+
+      def self.const_missing(c)
+        if c == :Property
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.product.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
     class Product < Bitrix24CloudApi::Crm
     end
   end

data/lib/bitrix24_cloud_api/CRM/product_row.rb

@@ -0,0 +1,11 @@
+module Bitrix24CloudApi
+  module CRM
+    class ProductRow < Bitrix24CloudApi::Base
+      [:list, :fields].each do |action|
+        define_singleton_method(action) do |client, query = {}|
+          client.make_get_request(resource_url(client, action), query)
+        end
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/property.rb

@@ -0,0 +1,11 @@
+module Bitrix24CloudApi
+  module CRM
+    class Property < Bitrix24CloudApi::Crm
+      class << self
+        def types(client, query = {})
+          client.make_get_request(resource_url(client, __method__), query)
+        end
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/requisite.rb

@@ -0,0 +1,54 @@
+module Bitrix24CloudApi
+  module CRM
+    module REQUISITE
+      module PRESET
+        class Field < Bitrix24CloudApi::Crm
+          class << self
+            def availabletoadd(client, query = {})
+              client.make_get_request(resource_url(client, __method__), query)
+            end
+          end
+        end
+      end
+
+      def self.const_missing(c)
+        if [:Userfield].any?{|x| x == c}
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.requisite.#{c.downcase}" }
+          target_class
+        end
+      end
+
+      class Bankdetail < Bitrix24CloudApi::Crm
+      end
+
+      class Link < Bitrix24CloudApi::Base
+        [:fields, :get, :list].each do |action|
+          define_singleton_method(action) do |client, query = {}|
+            client.make_get_request(resource_url(client, action), query)
+          end
+        end
+
+        [:register, :unregister].each do |action|
+          define_singleton_method(action) do |client, query = {}|
+            client.make_post_request(resource_url(client, action), query)
+          end
+        end
+      end
+
+      class Preset < Bitrix24CloudApi::Crm
+        class << self
+          def countries(client, query = {})
+            client.make_get_request(resource_url(client, __method__), query)
+          end
+        end
+      end
+    end
+
+    class Requisite < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :update
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/status.rb

@@ -0,0 +1,16 @@
+module Bitrix24CloudApi
+  module CRM
+    module STATUS
+      def self.const_missing(c)
+        if c == :Entity
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.status.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
+    class Status < Bitrix24CloudApi::Crm
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/userfield.rb

@@ -0,0 +1,22 @@
+module Bitrix24CloudApi
+  module CRM
+    module USERFIELD
+      def self.const_missing(c)
+        if [:Settings, :Enumeration].any?{|x| x == c}
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.userfield.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
+    class Userfield < Bitrix24CloudApi::Crm
+      class << self
+
+        def types(client, query = {})
+          client.make_get_request(resource_url(client, __method__), query)
+        end
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/vat.rb

@@ -0,0 +1,6 @@
+module Bitrix24CloudApi
+  module CRM
+    class Vat < Bitrix24CloudApi::Crm
+    end
+  end
+end

data/lib/bitrix24_cloud_api/aliases.rb

@@ -0,0 +1,7 @@
+module B24
+  include Bitrix24CloudApi
+end
+
+module B24_CRM
+  include Bitrix24CloudApi::CRM
+end

data/lib/bitrix24_cloud_api/base.rb

@@ -4,16 +4,22 @@ module Bitrix24CloudApi
   class Base
     require "httparty"
     extend Forwardable
-    def_delegators 'self.class', :resource_url
+    def_delegators 'self.class', :resource_url, :to_query
 
     class << self
 
+      def to_query(params)
+        params.to_a.map { |x| "#{CGI.escape(x[0].to_s)}=#{CGI.escape(x[1].to_s)}" }.join("&")
+      end
+
       def resource_url(client, action)
-        "#{client.api_endpoint + resource_path}.#{action}.#{client.extension}"
+        path = client.api_endpoint
+        path << "#{resource_path}." unless resource_path.empty?
+        path << "#{action}.#{client.extension}"
       end
 
-      def resource_path
-        name.gsub("Bitrix24CloudApi::", "").gsub("::", ".").downcase
+      def resource_path(exact_name = nil)
+        exact_name || name.gsub("Bitrix24CloudApi::", "").gsub("::", ".").downcase
       end
     end
   end

data/lib/bitrix24_cloud_api/client.rb

@@ -3,11 +3,12 @@ module Bitrix24CloudApi
   class Client < Base
     require 'oauth2'
 
+    B24_OAUTH_ENDPOINT = 'https://oauth.bitrix.info/oauth/token'
+
     attr_reader :endpoint, :access_token, :redirect_uri, :client_id, :client_secret, :scope, :oauth2client, :extension
     attr_writer :access_token
 
     def initialize(attrs = {})
-      puts attrs[:extension]
       @extension = attrs[:extension] || "json"
       @endpoint = attrs[:endpoint]
       @access_token = attrs[:access_token]
@@ -27,47 +28,43 @@ module Bitrix24CloudApi
     def authorize_url
       return nil unless oauth2client
 
-      oauth2client.auth_code.authorize_url(:redirect_uri => redirect_uri)
+      oauth2client.auth_code.authorize_url(:redirect_uri => redirect_uri, state: true)
     end
 
     def get_access_token(code)
       return nil unless oauth2client
 
-      auth_token_query = {}
-      auth_token_query[:client_id] = client_id
-      auth_token_query[:client_secret] = client_secret
-      auth_token_query[:grant_type] = "authorization_code"
-      auth_token_query[:scope] = scope
-      auth_token_query[:redirect_uri] = redirect_uri
-      auth_token_path = oauth2client.options[:token_url] + "?#{to_query(auth_token_query)}"
+      auth_token_query = { client_id: client_id,
+                           client_secret: client_secret,
+                           grant_type: 'authorization_code',
+                           code: code }
+      auth_token_path = "#{B24_OAUTH_ENDPOINT}?#{to_query(auth_token_query)}"
       oauth2client.options[:token_url] = auth_token_path
-
       begin
         token = oauth2client.auth_code.get_token(code, :redirect_uri => redirect_uri)
-        token.params.merge({:access_token => token.token,
-                            :refresh_token => token.refresh_token,
-                            :expires_at => token.expires_at})
+        token.params.merge({ access_token: token.token,
+                             refresh_token: token.refresh_token,
+                             expires_at: token.expires_at })
       rescue OAuth2::Error
         return nil
       end
     end
 
-    def refresh_token(refresh_token_hash)
+    def refresh_token(refresh_token)
       return nil unless oauth2client
 
-      auth_token_query = {}
-      auth_token_query[:client_id] = client_id
-      auth_token_query[:client_secret] = client_secret
-      auth_token_query[:grant_type] = 'refresh_token'
-      auth_token_query[:refresh_token] = refresh_token_hash
-      auth_token_path = "/oauth/token?#{to_query(auth_token_query)}"
+      auth_token_query = { client_id: client_id,
+                           client_secret: client_secret,
+                           grant_type: 'refresh_token',
+                           refresh_token: refresh_token }
+      auth_token_path = "#{B24_OAUTH_ENDPOINT}?#{to_query(auth_token_query)}"
       oauth2client.options[:token_url] = auth_token_path
 
       begin
         token = oauth2client.get_token(auth_token_query)
-        token.params.merge({:access_token => token.token,
-                            :refresh_token => token.refresh_token,
-                            :expires_at => token.expires_at})
+        token.params.merge({ access_token: token.token,
+                             refresh_token: token.refresh_token,
+                             expires_at: token.expires_at })
       rescue OAuth2::Error
         return false
       end
@@ -75,13 +72,17 @@ module Bitrix24CloudApi
 
     def make_get_request(path, params = {})
       params.merge!(auth: access_token)
-      response = HTTParty.get(path, query: params)
+      response = HTTParty.get(path,
+                              query: params,
+                              query_string_normalizer: ->(query) { Bitrix24CloudApi::HashConversions.to_params(query) })
       check_response(response)
     end
 
     def make_post_request(path, params = {})
-      params.merge!(auth: access_token)
-      response = HTTParty.post(path, query: params)
+      response = HTTParty.post(path,
+                               body: params,
+                               query: { auth: access_token },
+                               query_string_normalizer: ->(query) { Bitrix24CloudApi::HashConversions.to_params(query) })
       check_response(response)
     end