youcanbookme 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36f53dab6a17b2b18709b2b46f3b57bee4b27bced5172e1b5b1b478ef930a5ee
+  data.tar.gz: 7dcd566aa70a702c9fac08b16c8be40006588e1902620be6d9460f68b38f0c8c
+SHA512:
+  metadata.gz: 86cf465f68b4b4d183504f0e5ef0d8cb814fcab79f8e1d8c6935abbf0f2c184d1f073b6026c4d8d3f5ea23b85f7e2756f6511924a1e547476d91956b6d8f08b1
+  data.tar.gz: 469f6024831bf01e032b14b4bb63d5232fc682cf11522f141536a05da78524f25765ded2c259e0bd910994b0625c4d2b9c39a8a1c54f79efefe0ab0e034e4de4

data/.github/workflows/gem-push.yml

@@ -0,0 +1,37 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Build and test
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake test
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        continue-on-error: true
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Build and test
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake test
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rubocom.yml

@@ -0,0 +1,69 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/SuppressedException:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 2
+
+Layout/LineLength:
+ AllowURI: true
+ Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    map:      'collect'
+    reduce:   'inject'
+    find:     'detect'
+    find_all: 'select'
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Lambda:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.0.1.alpha
+
+- Initial release.
+- support APIs
+  - GET `/v1/{accountId}`
+  - GET `/v1/subdomains/{subdomain}`
+  - GET `/v1/suggestedsubdomains`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at koshikawa2009@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in youcanbookme.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kenji Koshikawa
+
+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,119 @@
+# YouCanBook.me API Client
+
+[![Test](https://github.com/koshilife/youcanbookme-api-ruby-client/workflows/Test/badge.svg)](https://github.com/koshilife/youcanbookme-api-ruby-client/actions?query=workflow%3ATest)
+[![codecov](https://codecov.io/gh/koshilife/youcanbookme-api-ruby-client/branch/master/graph/badge.svg)](https://codecov.io/gh/koshilife/youcanbookme-api-ruby-client)
+[![Gem Version](https://badge.fury.io/rb/youcanbookme.svg)](http://badge.fury.io/rb/youcanbookme)
+[![license](https://img.shields.io/github/license/koshilife/youcanbookme-api-ruby-client)](https://github.com/koshilife/youcanbookme-api-ruby-client/blob/master/LICENSE.txt)
+
+## About
+
+These client libraries are created for [YouCanBook.me API](https://api.youcanbook.me/docs/index.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'youcanbookme'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install youcanbookme
+
+## Supported statuses each YouCanBook.me API
+
+- Account:
+  - [ ] POST `/v1/`
+  - [x] GET `/v1/{accountId}`
+  - [ ] PATCH `/v1/{accountId}`
+  - [ ] DELETE `/v1/{accountId}`
+- Appointment Types:
+  - [ ] POST `/v1/{accountId}/profiles/{profileId}/appointmenttypes/items`
+  - [ ] PATCH `/v1/{accountId}/profiles/{profileId}/appointmenttypes/items/{appointmentTypeId}`
+  - [ ] DELETE `/v1/{accountId}/profiles/{profileId}/appointmenttypes/items/{appointmentTypeId}`
+- Bookings:
+  - [ ] GET `/v1/{accountId}/bookings`
+  - [ ] GET `/v1/{accountId}/firedactions`
+  - [ ] GET `/v1/{accountId}/profiles/{profileId}/bookings`
+  - [ ] POST `/v1/{accountId}/profiles/{profileId}/bookings`
+  - [ ] GET `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
+  - [ ] PATCH `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
+  - [ ] DELETE `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
+  - [ ] GET `/v1/{accountId}/profiles/{profileId}/firedactions`
+  - [ ] GET `/v1/ics/{bookingSecret}/{bookingIdOrRef}.ics`
+  - [ ] GET `/v1/profiles/{profileIdOrSubdomain}/bookings/{bookingIdOrRef}/lobby`
+  - [ ] (Deprecated) GET `/v1/ics/{bookingRef}`
+  - [ ] (Deprecated) GET `/v1/ics/{bookingRef}.ics`
+- Calendars:
+  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars`
+  - [ ] POST `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars`
+  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - [ ] PUT `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - [ ] PATCH `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - [ ] DELETE `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+- Events:
+  - [ ] POST `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events`
+  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
+  - [ ] DELETE `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
+- Profile
+  - [ ] GET `/v1/{accountId}/profiles`
+  - [ ] POST `/v1/{accountId}/profiles`
+  - [ ] GET `/v1/{accountId}/profiles/{profileId}`
+  - [ ] PATCH `/v1/{accountId}/profiles/{profileId}`
+  - [ ] DELETE `/v1/{accountId}/profiles/{profileId}`
+  - [x] GET `/v1/subdomains/{subdomain}`
+  - [x] GET `/v1/suggestedsubdomains`
+- Query
+  - [ ] POST `/v1/{localAccountId}/queries`
+- Remote Account
+  - [ ] GET `/v1/{localAccountId}/remoteaccounts`
+  - [ ] POST `/v1/{localAccountId}/remoteaccounts`
+  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}`
+  - [ ] PATCH `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}`
+  - [ ] DELETE `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}`
+- Team Members:
+  - [ ] POST `/v1/{accountId}/profiles/{profileId}/teammembers/items`
+  - [ ] PATCH `/v1/{accountId}/profiles/{profileId}/teammembers/items/{teamMemberId}`
+  - [ ] DELETE `/v1/{accountId}/profiles/{profileId}/teammembers/items/{teamMemberId}`
+
+## Usage
+
+The APIs client needs account email and password(or token).
+This client setup step is below.
+
+```ruby
+# set token by YouCanBookMe.configure methods.
+YouCanBookMe.configure do |config|
+  config.username          = 'foobar@example.com'
+  config.password_or_token = '<PASSWORD_OR_TOKEN>'
+end
+client = YouCanBookMe::Client.new
+
+# set token by YouCanBookMe::Client initializer.
+username          = 'foobar@example.com'
+password_or_token = '<PASSWORD_OR_TOKEN>'
+client = YouCanBookMe::Client.new username, password_or_token
+```
+
+This client basic usage is below.
+
+```ruby
+TODO
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/koshilife/youcanbookme-api-ruby-client). 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the youcanbookme Api Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/koshilife/youcanbookme-api-ruby-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'youcanbookme'
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/youcanbookme.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'youcanbookme' => 'YouCanBookMe'
+)
+loader.collapse('**/models')
+loader.setup
+
+# module for YouCanBook.me apis client
+module YouCanBookMe
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/youcanbookme/client.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  # YouCanBookMe APIs client.
+  class Client
+    API_HOST = 'https://api.youcanbook.me'
+    API_VERSION = 'v1'
+
+    # @param [String] account_id a YouCanBook.me's account id(or email).
+    # @param [String] password_or_token a YouCanBook.me's account password or token.
+    # @raise [YouCanBookMe::Error] if the account_id is empty.
+    # @raise [YouCanBookMe::Error] if the password_or_token is empty.
+    def initialize(account_id = nil, password_or_token = nil)
+      @config = YouCanBookMe.configuration
+      @account_id = account_id || @config.account_id
+      @password_or_token = password_or_token || @config.password_or_token
+
+      check_not_empty @account_id, 'account_id'
+      check_not_empty @password_or_token, 'password_or_token'
+      @connection = HttpCommand.new @account_id, @password_or_token
+    end
+
+    #
+    # Account
+    #
+
+    def account_path
+      "/#{API_VERSION}/#{@account_id}"
+    end
+
+    #
+    # Get basic information about current account.
+    #
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Account]
+    def account(fields = nil)
+      params = set_fields_into_params(fields)
+      res = @connection.get account_path, params
+      Account.new res.body, self
+    end
+
+    #
+    # Get suggested subdomains
+    #
+    # @return [Array<String>]
+    def suggested_subdomains
+      res = @connection.get "/#{API_VERSION}/suggestedsubdomains"
+      res.body
+    end
+
+    #
+    # Get the subdomain is available or not.
+    #
+    # @param [String] subdomain
+    # @return [Boolean]
+    # @raise [YouCanBookMe::Error] if the subdomain arg is empty.
+    def subdomain_available?(subdomain)
+      check_not_empty subdomain, 'subdomain'
+      res = @connection.get "/#{API_VERSION}/subdomains/#{subdomain}"
+      res.body[:free]
+    end
+
+    private
+
+    def check_not_empty(value, name)
+      raise YouCanBookMe::Error, "#{name} is required." if blank? value
+    end
+
+    def blank?(value)
+      return true if value.nil?
+      return true if value.to_s.empty?
+
+      false
+    end
+
+    def set_fields_into_params(fields, params = nil)
+      params ||= {}
+      return params unless fields
+      return params unless fields.is_a? Array
+      return params if fields.empty?
+
+      params.merge(fields: fields.join(','))
+    end
+  end
+end