bitrix24_cloud_api 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lucky-@mail.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitrix24_cloud_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 nononoy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Bitrix24CloudApi
+
+Ruby library for [Bitrix24 REST API](https://dev.1c-bitrix.ru/rest_help/index.php) **(only Cloud version)**.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitrix24_cloud_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitrix24_cloud_api
+
+## Usage
+
+### Oauth2
+Bitrix24's oauth2 implementation not compatible with *oauth2 gem*, so there is some changes in realization. Firstly, you have to create client entity. CLIENT_ID and CLIENT_SECRET you can find in your Bitrix24 Marketplace app.
+    
+    params = { endpoint: api_endpoint,
+               client_id: CLIENT_ID,
+               client_secret: CLIENT_SECRET,
+               scope: "crm", [optional]
+               extension: "json", [optional]
+               redirect_uri: redirect_uri
+    }
+    @client = Bitrix24CloudApi::Client.new(params)     
+
+To get oauth2 authorize_url for **code** simple use:
+    
+    authorize_url = @client.authorize_url
+    
+To get oauth2 **access_token** use:
+
+    access_token = @client.get_access_token(code)
+
+it's response contains a hash with *oauth2 credentials* and some other usefull data.
+
+To **refresh** oauth2 **access_token** use:
+    
+    access_token = @client.refresh_token(refresh_token)
+    
+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)`. 
+      
+### CRM
+      
+Available models
+
+    * 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:
+    
+    params = { fields: {TITLE: title, PHONE: [VALUE: phone, VALUE_TYPE: "WORK"]} }
+    Bitrix24CloudApi::CRM::Lead.add(@client, params)
+    Bitrix24CloudApi::CRM::Lead.list(@client)
+    Bitrix24CloudApi::CRM::Lead.get(@client, ID: 1)
+    
+    
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nononoy/bitrix24_cloud_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'bitrix24_cloud_api'
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bitrix24_cloud_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bitrix24_cloud_api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitrix24_cloud_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitrix24_cloud_api"
+  spec.version       = Bitrix24CloudApi::VERSION
+  spec.authors       = ["Viacheslav Gruzdov"]
+  spec.email         = ["lucky-@mail.ru"]
+
+  spec.summary       = "Bitrix24 REST API on Ruby"
+  spec.description   = "Bitrix24 REST API wrapper (for only cloud version)"
+  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.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"
+end

data/lib/bitrix24_cloud_api/CRM/activity.rb

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

data/lib/bitrix24_cloud_api/CRM/additional_entities.rb

@@ -0,0 +1,63 @@
+module Bitrix24CloudApi
+  module CRM
+    class ProductRows < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :add, :delete, :update
+
+        def set(client, query = {})
+          client.make_post_request(resource_url(client, __method__), query)
+        end
+      end
+    end
+
+    class Userfield < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :fields
+
+        def types(client, query = {})
+          client.make_get_request(resource_url(client, __method__), query)
+        end
+      end
+    end
+
+    class Localizations < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :delete, :fields, :get
+
+        def set(client, query = {})
+          client.make_post_request(resource_url(client, __method__), query)
+        end
+      end
+    end
+
+    class Communication < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :add, :delete, :update, :get, :list
+      end
+    end
+
+    class Duplicate < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :add, :delete, :update, :get, :list
+
+        def findbycomm(client, query = {})
+          client.make_get_request(resource_url(client, __method__), query)
+        end
+      end
+    end
+
+    class Enum < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :add, :delete, :update, :get, :list
+      end
+
+      [:ownertype, :contenttype, :activitytype, :activitypriority, :activitydirection,
+       :activitynotifytype].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/catalog.rb

@@ -0,0 +1,9 @@
+module Bitrix24CloudApi
+  module CRM
+    class Catalog < Bitrix24CloudApi::Crm
+      class << self
+        undef_method :add, :delete, :update
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/company.rb

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

data/lib/bitrix24_cloud_api/CRM/contact.rb

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

data/lib/bitrix24_cloud_api/CRM/currency.rb

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

data/lib/bitrix24_cloud_api/CRM/deal.rb

@@ -0,0 +1,22 @@
+module Bitrix24CloudApi
+  module CRM
+    module DEAL
+      def self.const_missing(c)
+        if [:Userfield, :ProductRows].any?{|x| x == c}
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.deal.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
+    class Deal < Bitrix24CloudApi::Crm
+
+      [:types, :set].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

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

data/lib/bitrix24_cloud_api/CRM/invoice_status.rb

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

data/lib/bitrix24_cloud_api/CRM/lead.rb

@@ -0,0 +1,16 @@
+module Bitrix24CloudApi
+  module CRM
+    module LEAD
+      def self.const_missing(c)
+        if [:Userfield, :ProductRows].any?{|x| x == c}
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.lead.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
+    class Lead < Bitrix24CloudApi::Crm
+    end
+  end
+end

data/lib/bitrix24_cloud_api/CRM/product.rb

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

data/lib/bitrix24_cloud_api/CRM/product_section.rb

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

data/lib/bitrix24_cloud_api/CRM/quote.rb

@@ -0,0 +1,16 @@
+module Bitrix24CloudApi
+  module CRM
+    module QUOTE
+      def self.const_missing(c)
+        if [:Userfield, :ProductRows].any?{|x| x == c}
+          target_class = Bitrix24CloudApi::CRM.const_get(c)
+          target_class.define_singleton_method(:resource_path) { "crm.quote.#{c.downcase}" }
+          target_class
+        end
+      end
+    end
+
+    class Quote < Bitrix24CloudApi::Crm
+    end
+  end
+end

data/lib/bitrix24_cloud_api/base.rb

@@ -0,0 +1,20 @@
+module Bitrix24CloudApi
+  require 'forwardable'
+
+  class Base
+    require "httparty"
+    extend Forwardable
+    def_delegators 'self.class', :resource_url
+
+    class << self
+
+      def resource_url(client, action)
+        "#{client.api_endpoint + resource_path}.#{action}.#{client.extension}"
+      end
+
+      def resource_path
+        name.gsub("Bitrix24CloudApi::", "").gsub("::", ".").downcase
+      end
+    end
+  end
+end

data/lib/bitrix24_cloud_api/client.rb

@@ -0,0 +1,111 @@
+module Bitrix24CloudApi
+
+  class Client < Base
+    require 'oauth2'
+
+    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]
+      @client_id = attrs[:client_id]
+      @client_secret = attrs[:client_secret]
+      @redirect_uri = attrs[:redirect_uri]
+      @scope = attrs[:scope]
+      if @client_id && @client_secret
+        @oauth2client = OAuth2::Client.new(@client_id, @client_secret, :site => api_endpoint)
+      end
+    end
+
+    def api_endpoint
+      "https://#{endpoint}/rest/"
+    end
+
+    def authorize_url
+      return nil unless oauth2client
+
+      oauth2client.auth_code.authorize_url(:redirect_uri => redirect_uri)
+    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)}"
+      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})
+      rescue OAuth2::Error
+        return nil
+      end
+    end
+
+    def refresh_token(refresh_token_hash)
+      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)}"
+      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})
+      rescue OAuth2::Error
+        return false
+      end
+    end
+
+    def make_get_request(path, params = {})
+      params.merge!(auth: access_token)
+      response = HTTParty.get(path, query: params)
+      check_response(response)
+    end
+
+    def make_post_request(path, params = {})
+      params.merge!(auth: access_token)
+      response = HTTParty.post(path, query: params)
+      check_response(response)
+    end
+
+    def check_response(response)
+      if response.success?
+        response.parsed_response
+      else
+        response.parsed_response.merge(code: response.code)
+      end
+    end
+
+    def deals
+      Bitrix24CloudApi::CRM::Deal.list(self)
+    end
+
+    def leads
+      Bitrix24CloudApi::CRM::Lead.list(self)
+    end
+
+    def contacts
+      Bitrix24CloudApi::CRM::Contact.list(self)
+    end
+
+    class << self
+    end
+  end
+end

data/lib/bitrix24_cloud_api/crm.rb

@@ -0,0 +1,32 @@
+module Bitrix24CloudApi
+
+  class Crm < Base
+
+   [:add, :delete, :update].each do |action|
+     define_singleton_method(action) do |client, query = {}|
+       client.make_post_request(resource_url(client, action), query)
+     end
+   end
+
+
+   [:get, :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
+
+require "bitrix24_cloud_api/CRM/additional_entities"
+require "bitrix24_cloud_api/CRM/activity"
+require "bitrix24_cloud_api/CRM/catalog"
+require "bitrix24_cloud_api/CRM/company"
+require "bitrix24_cloud_api/CRM/contact"
+require "bitrix24_cloud_api/CRM/currency"
+require "bitrix24_cloud_api/CRM/deal"
+require "bitrix24_cloud_api/CRM/invoice"
+require "bitrix24_cloud_api/CRM/invoice_status"
+require "bitrix24_cloud_api/CRM/lead"
+require "bitrix24_cloud_api/CRM/product"
+require "bitrix24_cloud_api/CRM/product_section"
+require "bitrix24_cloud_api/CRM/quote"