osuny_api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1a3d2e6cd60019b441bb74ea0a77416530c7db75ecf2ec8abfb0c7628b39bde
+  data.tar.gz: 5220e60f717e00ec7fa04fe76be021b3432578d83cf5381f94b79d779ad888c1
+SHA512:
+  metadata.gz: 92967da0c264a577a5ec3c8a894042fd56df180d9657a79aa64aee964ad2007fdfb82f677f40d7780af9a231842f71d2515fef791a3e5c49d3e2353157c2c994
+  data.tar.gz: f232a0fb21d4e152450abddfe081daf801525332c6da3a274b8b63f8cac09658a9618880c9e31785abf1c7e43195e7995375b3923b8d672bd50d23b726442b1d

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    osuny_api (0.2.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.5)
+    multi_xml (0.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-darwin-22
+
+DEPENDENCIES
+  osuny_api!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Arnaud Levy
+
+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,30 @@
+# Osuny API
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add osuny_api
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install osuny_api
+
+## Usage
+
+```
+osuny = OsunyApi.new  instance: 'https://instance.osuny.org',
+                      token: 'real_token'
+
+migration_identifier = "identifiant-unique"
+post = {
+  title: 'Titre importé'
+}
+osuny.communication
+     .website('real_website_id')
+     .post
+     .import(migration_identifier, post)
+```
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/osuny_api/client.rb

@@ -0,0 +1,39 @@
+require 'httparty'
+
+class OsunyApi::Client
+  attr_reader :instance, :token
+
+  LOG_GREEN = 32
+  LOG_RED = 31
+
+  def initialize(options = {})
+    @instance = options[:instance]
+    @token = options[:token]
+  end
+
+  def communication
+    @communication ||= OsunyApi::Communication.new(
+      client: self,
+      parent: OsunyApi::Resource.new(client: self)
+    )
+  end
+
+  def post(url, body = {})
+    log "[POST] #{url}", LOG_GREEN
+    response = HTTParty.post  url,
+    body: body,
+    headers: headers
+    log response.code
+  end
+
+  protected
+
+  def headers
+    { "X-Osuny-Token": token }
+  end
+
+  def log(string, color = nil)
+    puts color.nil? ? string
+                    : "\e[#{color}m#{string}\e[0m"
+  end
+end

data/lib/osuny_api/communication/website/post.rb

@@ -0,0 +1,13 @@
+class OsunyApi::Communication::Website::Post < OsunyApi::Resource
+
+  def path
+    'posts/'
+  end
+
+  def import(migration_identifier, data)
+    client.post "#{full_path}import", {
+      migration_identifier: migration_identifier,
+      post: data
+    }
+  end
+end

data/lib/osuny_api/communication/website.rb

@@ -0,0 +1,12 @@
+class OsunyApi::Communication::Website < OsunyApi::Resource
+  attr_accessor :id
+
+  def path
+    id.nil? ? "websites/"
+            : "websites/#{id}/"
+  end
+
+  def post
+    @post ||= Post.new(client: client, parent: self)
+  end
+end

data/lib/osuny_api/communication.rb

@@ -0,0 +1,11 @@
+class OsunyApi::Communication < OsunyApi::Resource
+  def path
+    'communication/'
+  end
+
+  def website(id = nil)
+    @website ||= Website.new(client: client, parent: self)
+    @website.id = id
+    @website
+  end
+end

data/lib/osuny_api/error.rb

@@ -0,0 +1,2 @@
+class OsunyApi::Error < StandardError
+end

data/lib/osuny_api/resource.rb

@@ -0,0 +1,18 @@
+class OsunyApi::Resource
+  attr_reader :parent, :client
+
+  def initialize(options = {})
+    @client = OsunyApi::Client.new options if options.has_key? :token
+    @parent = options[:parent] if options.has_key? :parent
+    @client = options[:client] if options.has_key? :client
+  end
+
+  def path
+    "#{client.instance}/api/osuny/"
+  end
+
+  def full_path
+    parent.nil? ? "#{path}"
+                : "#{parent.full_path}#{path}"
+  end
+end

data/lib/osuny_api/version.rb

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

data/lib/osuny_api.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "osuny_api/client"
+require_relative "osuny_api/error"
+require_relative "osuny_api/version"
+
+require_relative "osuny_api/resource"
+require_relative "osuny_api/communication"
+require_relative "osuny_api/communication/website"
+require_relative "osuny_api/communication/website/post"
+
+module OsunyApi
+  class << self
+    def new(options = {})
+      OsunyApi::Client.new options
+    end
+  end
+end

data/osuny_api.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/osuny_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "osuny_api"
+  spec.version = OsunyApi::VERSION
+  spec.authors = ["Arnaud Levy", "Sébastien Gaya"]
+  spec.email = ["contact@arnaudlevy.com", "sebastien.gaya@gmail.com"]
+
+  spec.summary = "Gem Ruby pour l'API Osuny"
+  spec.homepage = "https://www.github.com/noesya/osuny_api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/noesya/osuny_api"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|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 "httparty"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: osuny_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Arnaud Levy
+- Sébastien Gaya
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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:
+- contact@arnaudlevy.com
+- sebastien.gaya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/osuny_api.rb
+- lib/osuny_api/client.rb
+- lib/osuny_api/communication.rb
+- lib/osuny_api/communication/website.rb
+- lib/osuny_api/communication/website/post.rb
+- lib/osuny_api/error.rb
+- lib/osuny_api/resource.rb
+- lib/osuny_api/version.rb
+- osuny_api.gemspec
+homepage: https://www.github.com/noesya/osuny_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/noesya/osuny_api
+  source_code_uri: https://www.github.com/noesya/osuny_api
+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.4.13
+signing_key:
+specification_version: 4
+summary: Gem Ruby pour l'API Osuny
+test_files: []