spyri-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5555a66d22f3d689dbf782661c89edcbc6b15df460476d4d7d78265ff64ddd7
+  data.tar.gz: 8ce1848cae2871ee384175e3c7e283aa0ab5c5b29d2f3fd265652a04961411e3
+SHA512:
+  metadata.gz: 721e0f90724e9504cfd950b8da10fb8486364c6cf2d6842c7b85241169d28f737bb717cc1b9c8078828be43ddb34bbdd39b3cf50373844a0eedd3732b5d3afec
+  data.tar.gz: fcc9dec7defab91c3996a0400ee60ef96db7296d355f7296636cff4785b339fe224b24fe3c6dcb9dcb8a862e4db3124d535a320be10d0f14d59a1cae1e8df8c9

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2024-11-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spyri-api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Le Temps
+
+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,58 @@
+# SpyriApi
+
+Ruby client library for the Spyri API
+
+## Installation
+
+### RubyGems
+
+Just excute:
+
+    $ bundle add 'spyri-api'
+
+### Manually
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spyri-api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install spyri-api
+
+## Usage
+
+### Quickstart
+
+```ruby
+begin
+  client = SpyriApi::Client.new
+  client.set_config({
+    access_token: 'YOUR_SPYRI_API_TOKEN', 
+    host: 'YOUR_SPYRI_API_URL'
+  })
+  users_endpoint = SpyriApi::Users.new(client)
+  results = users_endpoint.search(email: "toto@test.com")
+  p results
+rescue SpyriApi::Error => e
+  puts "Error: #{e}"
+end
+```
+
+## API Documentation
+
+You can find documentation about the Spyri API on the [developers website](https://developers.letemps.ch/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/letemps-ch/spyri-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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "spyri_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(__FILE__)

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/spyri-api.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spyri_api/client"
+require "spyri_api/error"
+require "spyri_api/invoices"
+require "spyri_api/subscriptions"
+require "spyri_api/users"

data/lib/spyri_api/client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SpyriApi
+  class Client
+
+    def initialize(config = {})
+      set_config(config)
+    end
+
+    def set_config(config = {})
+      @access_token = config[:access_token] || ''
+      @host = config[:host] || ''
+
+      timeout = config[:timeout] || 120
+      @write_timeout = config[:write_timeout] || timeout
+      @read_timeout = config[:read_timeout] || timeout
+      @connect_timeout = config[:connect_timeout] || timeout
+    end
+
+    def call_api(http_method, path, opts = {})
+      headers = {'Content-Type' => "application/json"}
+      headers[:Authorization] = "Bearer #{@access_token}"
+
+      conn = Excon.new(@host + path, headers: headers, read_timeout: @read_timeout, write_timeout: @write_timeout, connect_timeout: @connect_timeout)
+
+      res = nil
+      case http_method.to_sym.downcase
+      when :post, :put, :patch, :delete
+        res = conn.request(method: http_method, query: opts[:query_params], body: opts[:body].to_json)
+      when :get
+        res = conn.get(query: opts[:query_params])
+      end
+
+      data = nil
+      data = JSON.parse(res.body) if res.status == 200
+
+      if (!data)
+        return Error.new(res.status, res.body)
+      end
+
+      return data
+    end
+
+  end
+end

data/lib/spyri_api/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SpyriApi
+  class Error < StandardError
+
+    attr_reader :status, :code, :details
+
+    def initialize(status, body)
+      @status = status
+      if @status == 404
+        @code = 'not_found'
+      else
+        data = JSON.parse(body)
+        @code = data['code']
+        @details = data['details']
+      end
+      super @code
+    end
+
+    def inspect
+      "<#{self.class}: #{instance_variables.map { |v| "#{v}=#{instance_variable_get(v)}"}.join(', ')}>"
+    end
+  end
+end

data/lib/spyri_api/invoices.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SpyriApi
+  class Invoices
+
+    BASEPATH = '/invoices'.freeze
+
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def search(opts = {})
+      query_params = {}
+      [:code, :subscription_id, :user_id].each do |key|
+        query_params[key.to_s] = opts[key] if !opts[key].blank?
+      end
+      path = BASEPATH
+      data = @api_client.call_api(:GET, path, query_params: query_params)
+      return data
+    end
+
+    def get(id)
+      path = "#{BASEPATH}/#{id}"
+      data = @api_client.call_api(:GET, path)
+      return data
+    end
+
+  end
+end

data/lib/spyri_api/subscriptions.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SpyriApi
+  class Subscriptions
+
+    BASEPATH = '/subscriptions'.freeze
+
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def search(opts = {})
+      query_params = {}
+      [:erp_id].each do |key|
+        query_params[key.to_s] = opts[key] if !opts[key].blank?
+      end
+      path = BASEPATH
+      data = @api_client.call_api(:GET, path, query_params: query_params)
+      return data
+    end
+
+    def get(id)
+      path = "#{BASEPATH}/#{id}"
+      data = @api_client.call_api(:GET, path)
+      return data
+    end
+
+    def create(subscription_object)
+      path = BASEPATH
+      data = @api_client.call_api(:POST, path, body: { subscription: subscription_object })
+    end
+
+  end
+end

data/lib/spyri_api/users.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SpyriApi
+  class Users
+
+    BASEPATH = '/users'.freeze
+
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def search(opts = {})
+      query_params = {}
+      [:email, :name, :phone_number, :erp_id].each do |key|
+        query_params[key.to_s] = opts[key] if !opts[key].blank?
+      end
+      path = BASEPATH
+      data = @api_client.call_api(:GET, path, query_params: query_params)
+      return data
+    end
+
+    def get(id)
+      path = "#{BASEPATH}/#{id}"
+      data = @api_client.call_api(:GET, path)
+      return data
+    end
+
+    def create(user_object)
+      path = BASEPATH
+      data = @api_client.call_api(:POST, path, body: { user: user_object })
+    end
+
+    def update(id, user_object)
+      path = "#{BASEPATH}/#{id}"
+      data = @api_client.call_api(:PATCH, path, body: { user: user_object })
+    end
+
+  end
+end

data/lib/spyri_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SpyriApi
+  VERSION = "0.1.0"
+end

data/spyri-api.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/spyri_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "spyri-api"
+  spec.version       = SpyriApi::VERSION
+  spec.authors       = ["pabois"]
+  spec.email         = ["pierreandre.boissinot@noesya.coop"]
+
+  spec.summary       = "Ruby client library for the Spyri API"
+  spec.homepage      = "https://github.com/letemps-ch/spyri-api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/letemps-ch/spyri-api"
+  spec.metadata["changelog_uri"] = "https://github.com/letemps-ch/spyri-api/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "excon"
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: spyri-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pabois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- pierreandre.boissinot@noesya.coop
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spyri-api.rb
+- lib/spyri_api/client.rb
+- lib/spyri_api/error.rb
+- lib/spyri_api/invoices.rb
+- lib/spyri_api/subscriptions.rb
+- lib/spyri_api/users.rb
+- lib/spyri_api/version.rb
+- spyri-api.gemspec
+homepage: https://github.com/letemps-ch/spyri-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/letemps-ch/spyri-api
+  source_code_uri: https://github.com/letemps-ch/spyri-api
+  changelog_uri: https://github.com/letemps-ch/spyri-api/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby client library for the Spyri API
+test_files: []