websy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1963f2ddea6720cbf727cf5335962e61851dc8d0752edc41ff9c0a102d40efa9
+  data.tar.gz: e72c16aa8c8d1bce84f2f99848b8460145f79b69b3cda1ea6e13a0abc060132e
+SHA512:
+  metadata.gz: 92b179612329d482a8a8687289d0a7a76e877b642106e26d9453eba2edb47566b23385a6a31583a4e235eb875785b6a640ba11d39ac93cd1f42483359be34838
+  data.tar.gz: ad6dbfb9079b9c29148d7ff346a74a9ba5e636c9ccdcbc875e1e8c2abebca30f33c455c195594eb496153f9197148be9005b47d0f8f68a914c855e4d74abed98

data/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.3']
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      # - name: StandardRb check
+      #   run: bundle exec standardrb
+
+      - name: Run tests
+        env:
+          WEBSY_TOKEN: fake
+        run: |
+          bundle exec rake test

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.DS_Store
+*.log
+TODO.md

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 / 2024-12-19
+
+- Securing gem name

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in websy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    websy (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ansi (1.5.0)
+    builder (3.2.3)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
+    minitest (5.11.3)
+    minitest-reporters (1.3.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    public_suffix (5.0.0)
+    rake (10.5.0)
+    rexml (3.2.5)
+    ruby-progressbar (1.9.0)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3, >= 1.3.0)
+  rake (~> 10.0)
+  vcr (~> 6.0)
+  webmock (~> 3.0)
+  websy!
+
+BUNDLED WITH
+   2.5.23

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yafoy
+
+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,56 @@
+# Websy
+
+[![Tests](https://github.com/skoolfood/websy/actions/workflows/ci.yml/badge.svg)](https://github.com/skoolfood/websy/actions/workflows/ci.yml)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'websy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install websy
+
+## Usage
+
+Add your credentials. In a Rails application, create an initializer for example `config/initializers/websy.rb`.
+
+```ruby
+Websy.token = ENV["WEBSY_TOKEN"]
+Websy.api_base = ENV["WEBSY_API_BASE"] # optional
+```
+
+Query records per resource type.
+
+```ruby
+Websy::Project.list
+Websy::Project.find(1)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+### Testing
+
+Run tests locally
+
+```
+WEBSY_TOKEN=XXX rake test TEST=**/*/project_test.rb
+WEBSY_TOKEN=XXX rake test
+
+## 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,10 @@
+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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "websy"
+
+# 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/websy/api_operation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Websy
+  class ApiOperation
+
+    def self.api
+      @api ||= HttpDecorator.new(Websy.api_url)
+    end
+  end
+end

data/lib/websy/errors/api_connection_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Websy
+  class APIConnectionError < ServiceError
+  end
+end

data/lib/websy/errors/api_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Websy
+  class APIError < ServiceError
+  end
+end

data/lib/websy/errors/authentication_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Websy
+  class AuthenticationError < ServiceError
+  end
+end

data/lib/websy/errors/invalid_request_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Websy
+  class InvalidRequestError < ServiceError
+    attr_accessor :param
+
+    def initialize(message, param, http_status = nil, http_body = nil, json_body = nil)
+      super(message, http_status, http_body, json_body)
+      @param = param
+    end
+  end
+end

data/lib/websy/errors/service_error.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Websy
+  class ServiceError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message = nil, http_status = nil, http_body = nil, json_body = nil)
+      @message     = message
+      @http_status = http_status
+      @http_body   = http_body
+      @json_body   = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/websy/http_decorator.rb

@@ -0,0 +1,170 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+require "openssl"
+require "net/http"
+require "json"
+require "uri"
+
+module Websy
+  # https://lecklider.com/2016/09/decorating-ruby-s-net-http-for-fun-and-profit.html
+  #
+  class HttpDecorator
+    # Timeouts
+    OPEN_TIMEOUT = 10  # in seconds
+    READ_TIMEOUT = 120 # in seconds
+
+    # Content-types
+    CONTENT_TYPE_JSON = "application/json"
+    CONTENT_TYPE_FORM = "application/x-www-form-urlencoded"
+    # CONTENT_TYPE_MULTIPART = "multipart/form-data; boundary=#{ Rack::Multipart::MULTIPART_BOUNDARY }"
+
+    def initialize(url)
+      if Websy.token.nil?
+        raise AuthenticationError.new("No token provided")
+      end
+
+      # Build up our HTTP object
+      uri = URI(url)
+      @http = Net::HTTP.new(uri.hostname, uri.port)
+      @http.use_ssl = true if uri.scheme == "https"
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE if uri.scheme == "https"
+      @http.open_timeout = OPEN_TIMEOUT
+      @http.read_timeout = READ_TIMEOUT
+
+      # In local development we can log requests and responses to $stdout.
+      #   DO NOT EVER do this in production. EVER.
+      if ENV["RACK_ENV"] == "development"
+        @http.set_debug_output($stdout)
+      end
+    end
+
+    # Open a connection for multiple calls.
+    # - Accepts a block, otherwise just opens the connection.
+    # - You'll need to close the connection if you just open it.
+    def start
+      if block_given?
+        # Open the connection.
+        @http.start unless @http.started?
+
+        # Yield to the calling block.
+        yield(self)
+
+        # Clean up the connection.
+        @http.finish if @http.started?
+      else
+        # Open the connection.
+        @http.start unless @http.started?
+      end
+    end
+
+    # Clean up the connection if needed.
+    def finish
+      @http.finish if @http.started?
+    end
+
+    # GET
+    def get(path, **params)
+      uri       = URI.parse(path)
+      uri.query = URI.encode_www_form(params) unless params.empty?
+      request   = Net::HTTP::Get.new(uri.to_s)
+
+      parse fetch(request)
+    end
+
+    # POST
+    def post(path, as: :json, **params)
+      request = Net::HTTP::Post.new(path)
+
+      case as
+      when :json
+        request.content_type = CONTENT_TYPE_JSON
+        request.body = JSON.generate(params) unless params.empty?
+      else
+        request.content_type = CONTENT_TYPE_FORM
+        request.body = URI.encode_www_form(params) unless params.empty?
+      end
+
+      parse fetch(request)
+    end
+
+    # DELETE
+    def delete(path)
+      request = Net::HTTP::Delete.new(path)
+
+      parse fetch(request)
+    end
+
+    # PATCH
+    def patch(path, as: :form, **params)
+      request = Net::HTTP::Patch.new(path)
+
+      case as
+      when :json
+        request.content_type = CONTENT_TYPE_JSON
+        request.body = JSON.generate(params) unless params.empty?
+      else
+        request.content_type = CONTENT_TYPE_FORM
+        request.body = URI.encode_www_form(params) unless params.empty?
+      end
+
+      parse fetch(request)
+    end
+
+    # PUT
+    def put(path, as: :json, **params)
+      request = Net::HTTP::Put.new(path)
+
+      case as
+      when :json
+        request.content_type = CONTENT_TYPE_JSON
+        request.body = JSON.generate(params) unless params.empty?
+      else
+        request.content_type = CONTENT_TYPE_FORM
+        request.body = URI.encode_www_form(params) unless params.empty?
+      end
+
+      parse fetch(request)
+    end
+
+    # POST multipart
+    def multipart(path, **params)
+      request = Net::HTTP::Post.new(path)
+
+      request.content_type = CONTENT_TYPE_MULTIPART
+      request.body = Rack::Multipart::Generator.new(
+        "file" => Rack::Multipart::UploadedFile.new(params["file"][:tempfile].path, params["file"][:type])
+      ).dump
+
+      parse fetch(request)
+    end
+
+    private
+
+    # Perform the request.
+    def fetch(request)
+      # Shore up default headers for the request.
+      request["Accept"] = CONTENT_TYPE_JSON
+      request["Connection"] = "keep-alive"
+      request["User-Agent"] =  "Websy Ruby v#{Websy::VERSION}"
+      request["Authorization"] = "Token token=#{Websy.token}"
+
+      # Actually make the request.
+      response = @http.request(request)
+
+      # Net::HTTPResponse.value will raise an error for non-200 responses.
+      #   Simpler than trying to detect every possible exception.
+      response.value || response
+    end
+
+    def parse(response)
+      # Parse the response as JSON if possible.
+      if response.content_type == CONTENT_TYPE_JSON
+        JSON.parse(response.body)
+
+      # Otherwise just return the response body.
+      else
+        response.body
+      end
+    end
+  end
+end

data/lib/websy/project.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Websy
+  class Project < ApiOperation
+
+    def self.list(params = {})
+      api.get(resource_url, **params)
+    end
+
+    def self.find(id)
+      api.get(resource_url(id.to_s))
+    end
+
+    private
+
+      def self.resource_url(url = "")
+        Websy.api_url("/projects/") + url
+      end
+  end
+end

data/lib/websy/version.rb

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

data/lib/websy.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "websy/version"
+
+# API operations
+require "websy/http_decorator"
+require "websy/api_operation"
+
+# Resource
+require "websy/project"
+
+# Errors
+require "websy/errors/service_error"
+require "websy/errors/api_error"
+require "websy/errors/api_connection_error"
+require "websy/errors/invalid_request_error"
+require "websy/errors/authentication_error"
+
+module Websy
+  @api_base = "https://apimocks.herokuapp.com".freeze
+
+  class << self
+    attr_accessor :token, :api_base
+
+    def api_url(path = "")
+      @api_base + path
+    end
+  end
+end

data/websy.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "websy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "websy"
+  spec.version       = Websy::VERSION
+  spec.authors       = ["Olivier"]
+  spec.email         = ["olivier@yafoy.com"]
+
+  spec.summary       = "A Ruby gem for interacting with XXX's REST API"
+  spec.homepage      = "https://github.com/skoolfood/websy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3", ">= 1.3.0"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: websy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olivier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- olivier@yafoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/websy.rb
+- lib/websy/api_operation.rb
+- lib/websy/errors/api_connection_error.rb
+- lib/websy/errors/api_error.rb
+- lib/websy/errors/authentication_error.rb
+- lib/websy/errors/invalid_request_error.rb
+- lib/websy/errors/service_error.rb
+- lib/websy/http_decorator.rb
+- lib/websy/project.rb
+- lib/websy/version.rb
+- websy.gemspec
+homepage: https://github.com/skoolfood/websy
+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.5.22
+signing_key:
+specification_version: 4
+summary: A Ruby gem for interacting with XXX's REST API
+test_files: []