yclients-api 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33627f7c7369e4a4da37d19a43b2939cd3306ae5ff32c06287cbd428acde0717
+  data.tar.gz: 1dfd416c56bf993e8329588df7e6af20064b91408742b82e1a03e789954315f4
+SHA512:
+  metadata.gz: 54dbbd9dd7ee404b154adb9114b904dcfa0e72412f77541bf554ddf41622913d3849c80ecb81f44051e45d293c51901aba4796fd3db110c5dfbb470fd7502d05
+  data.tar.gz: c3cbe3957b7fd3a98e6bdd2c67071c1610d2d916f0da0b67e27636aa6afd4ded98e6b25f7860f040958c5b479f251771de69b8660788119e1b80c4e7e8273c17

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/vcr/*
+/spec/support/client_credentials.rb
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.sw?

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :development do
+  gem "rake", "~> 12.0"
+  gem 'pry'
+  gem 'rb-readline'
+end
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem 'vcr'
+  gem 'webmock'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    yclients-api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (12.3.2)
+    rb-readline (0.5.5)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry
+  rake (~> 12.0)
+  rb-readline
+  rspec (~> 3.0)
+  vcr
+  webmock
+  yclients-api!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Maksim Akkuzin
+
+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,39 @@
+# Yclients::Api
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yclients/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yclients-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yclients-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/makkuzin/yclients-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yclients/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.
+
+require "pry"
+Pry.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/lib/yclients/api.rb

@@ -0,0 +1,8 @@
+require 'net/http'
+require 'json'
+
+require 'yclients/api/exception'
+require 'yclients/api/auth'
+require 'yclients/api/companies'
+require "yclients/api/client"
+require "yclients/api/version"

data/lib/yclients/api/auth.rb

@@ -0,0 +1,33 @@
+### Авторизация
+### https://yclients.docs.apiary.io/#reference/0
+module Yclients::Api
+  module Auth
+    URL = 'https://api.yclients.com/api/v1/auth'
+
+    def auth
+      @user_token || auth!
+    end
+
+    def auth!
+      unless @login || @password
+        raise AuthError, "Отсутствует логин или пароль"
+      end
+
+      uri = URI(URL)
+      req = Net::HTTP::Post.new(uri, headers)
+
+      req.body = { "login" => @login, "password" => @password }.to_json
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+      json = JSON.parse(res.body)
+
+      if json.key?('user_token')
+        @user_token = json['user_token']
+      else
+        raise AuthError, json.to_s
+      end
+    end
+  end
+end

data/lib/yclients/api/client.rb

@@ -0,0 +1,61 @@
+module Yclients::Api
+  class Client
+    include Auth
+    include Companies
+
+    attr_accessor :partner_token, :user_token, :login, :password
+
+    def initialize(args={})
+      @partner_token = args[:partner_token] or raise NoPartnerToken
+      @user_token = args[:user_token]
+      @login = args[:login]
+      @password = args[:password]
+    end
+
+    def has_user_token?
+      !!@user_token
+    end
+
+    def query_param(key, value, type)
+      case type
+      when :numeric
+        if value.respond_to?(:to_i) && value.to_i > 0
+          { key => value }
+        else
+          {}
+        end
+      when :boolean
+        if value == true
+          { key => 1 }
+        elsif value == false
+          { key => 0 }
+        else
+          {}
+        end
+      when :string
+        if value.kind_of?(String) && value.length > 0
+          { key => value }
+        else
+          {}
+        end
+      else
+        {}
+      end
+    end
+
+    def headers(args={auth: false})
+      if args[:auth]
+        {
+          'Authorization' => "Bearer #{@partner_token}, User #{@user_token}",
+          "Content-Type" => 'application/json'
+        }
+      else
+        {
+          'Authorization' => "Bearer #{@partner_token}",
+          "Content-Type" => 'application/json'
+        }
+      end
+    end
+
+  end
+end

data/lib/yclients/api/companies.rb

@@ -0,0 +1,77 @@
+### Компании
+### https://yclients.docs.apiary.io/#reference/2
+module Yclients::Api
+  module Companies
+    URL1 = 'https://api.yclients.com/api/v1/company' 
+    URL2 = 'https://api.yclients.com/api/v1/companies'
+
+    # group_id (Number, 83): ID сети компаний. Фильтр по идентификатору сети компаний Default: 83
+    # my (Number, 1): Только для авторизованного пользователя. Если нужно компании, на управление которыми пользователь имеет права
+    # active (Number, 1): Если нужно получить только активные для онлайн-записи компании
+    # moderated (Number, 1): Если нужно получить только прошедшие модерацию компании. Т.е. чей контент проверен для публикации
+    # for_booking (Number, 1): Если нужно получить поле next_slot по каждой компании
+    # show_groups (Number, 1): Включить в обьект компании список сетей в которые входит эта компания
+    # title: Поиск по вхождению подстроки в название компании
+    # distance: Радиус поиска
+    # coordinate_lat: Широта центра поиска по координатам
+    # coordinate_lon: Долгота центра поиска по координатам
+    def companies(args={})
+      uri = URI(URL2)
+      params = {}
+      params.merge!(query_param(:group_id, args[:group_id], :numeric)) if args.key?(:group_id)
+      params.merge!(query_param(:my, args[:my], :boolean)) if args.key?(:my)
+      params.merge!(query_param(:active, args[:active], :boolean)) if args.key?(:active)
+      params.merge!(query_param(:moderated, args[:moderated], :boolean)) if args.key?(:moderated)
+      params.merge!(query_param(:forBooking, args[:for_booking], :boolean)) if args.key?(:for_booking)
+      params.merge!(query_param(:show_groups, args[:show_groups], :boolean)) if args.key?(:show_groups)
+      params.merge!(query_param(:title, args[:title], :string)) if args.key?(:title)
+#     params.merge!(query_param(:distance, args[:distance], :string)) if args.key?(:distance)
+#     params.merge!(query_param(:coordinate_lat, args[:coordinate_lat], :string)) if args.key?(:coordinate_lat)
+#     params.merge!(query_param(:coordinate_lon, args[:coordinate_lon], :string)) if args.key?(:coordinate_lon)
+      uri.query = URI.encode_www_form(params)
+
+      req = Net::HTTP::Get.new(uri, headers({
+        auth: args.key?(:my) && [true, false].include?(args[:my])
+      }))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      json = JSON.parse(res.body)
+      if json.kind_of?(Array)
+        json
+      else
+        raise CompaniesAccessError, json.to_s
+      end
+    end
+
+    # for_booking (Number, 1): Если нужно получить поле next_slot по каждой компании
+    # show_groups (Number, 1): Включить в обьект компании список сетей в которые входит эта компания
+    def company(id, args={})
+      uri = URI("#{URL1}/#{id}/")
+      params = {}
+      params.merge!(query_param(:forBooking, args[:for_booking], :boolean)) if args.key?(:for_booking)
+      params.merge!(query_param(:show_groups, args[:show_groups], :boolean)) if args.key?(:show_groups)
+      uri.query = URI.encode_www_form(params)
+
+      req = Net::HTTP::Get.new(uri, headers({ auth: false }))
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      json = JSON.parse(res.body)
+      if json.kind_of?(Hash) && json.key?('id')
+        json
+      else
+        raise CompaniesAccessError, json.to_s
+      end
+    end
+
+=begin TODO
+    def edit_company(id, args={}); end
+    def delete_company(id); end
+=end
+  end
+end

data/lib/yclients/api/exception.rb

@@ -0,0 +1,10 @@
+module Yclients::Api
+  class NoPartnerToken < Exception
+    def initialize
+      super "Отсутствует partner token"
+    end
+  end
+
+  class AuthError < Exception; end
+  class CompaniesAccessError < Exception; end
+end

data/lib/yclients/api/version.rb

@@ -0,0 +1,5 @@
+module Yclients
+  module Api
+    VERSION = "0.1.2"
+  end
+end

data/yclients-api.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yclients/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yclients-api"
+  spec.version       = Yclients::Api::VERSION
+  spec.authors       = ["Maksim Akkuzin"]
+  spec.email         = ["maksim.akkuzin@yandex.ru"]
+
+  spec.summary       = %q{Yclients API}
+  spec.description   = %q{Ruby interface to the Yclients API}
+  spec.homepage      = "https://github.com/makkuzin/yclients-api"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: yclients-api
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Maksim Akkuzin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: Ruby interface to the Yclients API
+email:
+- maksim.akkuzin@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yclients/api.rb
+- lib/yclients/api/auth.rb
+- lib/yclients/api/client.rb
+- lib/yclients/api/companies.rb
+- lib/yclients/api/exception.rb
+- lib/yclients/api/version.rb
+- yclients-api.gemspec
+homepage: https://github.com/makkuzin/yclients-api
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Yclients API
+test_files: []