harpy 1.0.0 → 2.0.0.preview1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 35426c39b7a3ab5a5cbe8a32afd1db109a81f6dc
-  data.tar.gz: 6869a454bd349bbcd33a1aa7fe7fdce6255f087d
+SHA256:
+  metadata.gz: c6bccc44b8e3516964d14dfb259eb7b9294c42449c4f9f72876b5ed1852ed3d0
+  data.tar.gz: 989d3494a0b11a5ee04b2c472c2f3ac85920bf42296c3194c1a756f7e1ddd680
 SHA512:
-  metadata.gz: 3c730539fe647176feb1c0e1d60a05c8a8df3ac6ecb5e7b44cf8089f976fd1b3896d8f0c94dfd15dc8c47d338ac725b48ddbce6d23eb8b3b856e37a8ad980936
-  data.tar.gz: f95e41e0b7c2c54f69c324233be772a95ffc79c588d93c38bf8b314f3bef1a0d9a0938831c56a1ed2a23746a9923f3ab8a8aa579a8f2906d0a8a15684dd9f691
+  metadata.gz: c0d99509101d673e64f08a18d7dd0ac8335f59e462e60e51638e365fc54b5a11bb5cd43e1454052af17bab69ebb7a94b6b69dbd0de27a5d8932f694a90e61c5b
+  data.tar.gz: 83f63ada339c06bd86231d8175b767bf5e56afffd80d7862093189a28e2eb4c86cdf8243b5cd88113fca49715f8f6a94bda439983c024cbef383a171a5ee48d3

data/.forgejo/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: docker
+    container:
+      image: docker.io/library/ruby:${{ matrix.image }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: "3.4"
+            image: "3.4"
+          - ruby: "4.0"
+            image: "4.0"
+          - ruby: "4.1"
+            image: "4.1-rc"
+    steps:
+      - name: Install Node.js 24 for the checkout action
+        run: |
+          apt-get update
+          apt-get install -y ca-certificates curl
+          curl -fsSL https://deb.nodesource.com/setup_24.x | bash -
+          apt-get install -y nodejs
+          node --version
+      - name: Check out the repository
+        uses: actions/checkout@v7
+      - run: bundle install
+      - run: bundle exec rake

data/.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.4", "4.0", "4.1"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
 pkg/*
-*.rbc
+*.rbc
+Gemfile.lock

data/README.md

@@ -1,19 +1,18 @@
 Harpy
 ======
 
-[![Build Status](https://travis-ci.org/TalentBox/harpy.png?branch=master)](https://travis-ci.org/TalentBox/harpy)
-[![Code Climate](https://codeclimate.com/github/TalentBox/harpy.png)](https://codeclimate.com/github/TalentBox/harpy)
+[![Test](https://github.com/TalentBox/harpy/actions/workflows/test.yml/badge.svg)](https://github.com/TalentBox/harpy/actions/workflows/test.yml)
 
 Client for REST API with HATEOAS
 
 Dependencies
 ------------
 
-* Ruby 1.8.7 or 1.9.2
-* gem "typhoeus", "~> 0.2.4"
-* gem "activesupport", ">= 3.1.0"
-* gem "activemodel", ">= 3.1.0"
-* gem "hash-deep-merge", "~> 0.1.1"
+* Ruby >= 3.4.
+* gem "httpx", ">= 1.0"
+* gem "activesupport", ">= 5.2.0"
+* gem "activemodel", ">= 5.2.0"
+* gem "hash-deep-merge", ">= 0.1.1"
 
 Usage
 -----
@@ -44,7 +43,7 @@ Usage
         # => instance of MyModel with attributes filled in on 200
         # => nil on 404
         # => raises Harpy::ClientTimeout on timeout
-        # => raises Harpy::ClientError on Curl error
+        # => raises Harpy::ClientError on HTTP client error
         # => raises Harpy::InvalidResponseCode on other response codes
 
         # Fetch multiple by url in parallel
@@ -60,7 +59,7 @@ Usage
           }
         # => return an array of MyModel instances on 200
         # => raises Harpy::ClientTimeout on timeout
-        # => raises Harpy::ClientError on Curl error
+        # => raises Harpy::ClientError on HTTP client error
         # => raises Harpy::InvalidResponseCode on other response codes
 
         # Search by first_name

data/harpy.gemspec

@@ -1,9 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+require "harpy"
 
 Gem::Specification.new do |s|
   s.name        = "harpy"
-  s.version     = "1.0.0"
+  s.version     = Harpy::VERSION::STRING
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Joseph HALTER", "Jonathan TRON"]
   s.email       = ["joseph.halter@thetalentbox.com", "jonathan.tron@thetalentbox.com"]
@@ -11,17 +12,19 @@ Gem::Specification.new do |s|
   s.summary     = %q{Client for REST API}
   s.description = %q{Client for REST API with HATEOAS}
   s.license     = "MIT"
+  s.required_ruby_version = ">= 3.4"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "typhoeus", "~> 0.6.5"
-  s.add_runtime_dependency "activesupport", [">= 3.1.0"]
-  s.add_runtime_dependency "activemodel", [">= 3.1.0"]
-  s.add_runtime_dependency "hash-deep-merge", ["~> 0.1.1"]
+  s.add_runtime_dependency "httpx", ">= 1.0"
+  s.add_runtime_dependency "activesupport", [">= 5.2.0"]
+  s.add_runtime_dependency "activemodel", [">= 5.2.0"]
+  s.add_runtime_dependency "hash-deep-merge", [">= 0.1.1"]
 
   s.add_development_dependency "rake", [">= 0.8.7"]
   s.add_development_dependency "rspec"
+  s.add_development_dependency "webmock"
 end

data/lib/harpy/client.rb

@@ -1,4 +1,6 @@
-require "typhoeus"
+require "base64"
+require "openssl"
+require "httpx"
 require "hash_deep_merge"
 
 module Harpy
@@ -7,6 +9,7 @@ module Harpy
 
     def initialize(opts=nil)
       self.options = (opts || {})
+      @session = HTTPX::Session.new
     end
 
     def get(url_or_urls, opts=nil)
@@ -34,33 +37,68 @@ module Harpy
     end
 
     def run(requests)
-      requests.each{|request| Typhoeus::Hydra.hydra.queue request}
-      Typhoeus::Hydra.hydra.run
-      requests.collect(&:response)
+      return [] if requests.empty?
+
+      responses = @session.request(*requests)
+      responses.is_a?(Array) ? responses : [responses]
+    end
+
+    def response_status(response)
+      response.is_a?(HTTPX::ErrorResponse) ? 0 : response.status
     end
 
     def invalid_code(response)
-      if response.timed_out?
-        raise ClientTimeout
-      elsif response.code.zero?
-        raise ClientError, response.return_message
+      if response.is_a?(HTTPX::ErrorResponse)
+        if response.error.is_a?(HTTPX::TimeoutError)
+          raise ClientTimeout
+        else
+          raise ClientError, response.error.message
+        end
       else
-        raise InvalidResponseCode, response.code.to_s
+        raise InvalidResponseCode, response.status.to_s
       end
     end
 
   private
 
     def request(method, urls, opts=nil)
-      opts = options.deep_merge(opts || {})
+      opts = httpx_options(options.deep_merge(opts || {}))
       case urls
       when Array
-        requests = urls.collect do |url|
-          Typhoeus::Request.new url, opts.merge(:method => method)
+        urls.collect do |url|
+          @session.build_request(method, url, opts.dup)
         end
       else
-        Typhoeus::Request.send method, urls, opts
+        @session.request(method.to_s.upcase, urls, **opts)
+      end
+    end
+
+    def httpx_options(opts)
+      timeout = opts[:timeout]
+      if timeout.is_a?(Numeric)
+        opts[:timeout] = {total_request_timeout: timeout.to_f / 1000} if timeout.positive?
+        opts.delete(:timeout) unless timeout.positive?
+      end
+
+      ssl_options = (opts[:ssl] || {}).dup
+      if opts.key?(:ssl_verifypeer)
+        verify_peer = opts.delete(:ssl_verifypeer)
+        ssl_options[:verify_mode] = verify_peer ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+      end
+      if opts.key?(:ssl_verifyhost)
+        verify_host = opts.delete(:ssl_verifyhost)
+        ssl_options[:verify_hostname] = verify_host != false && verify_host != 0
+      end
+      opts[:ssl] = ssl_options unless ssl_options.empty?
+
+      username = opts.delete(:username)
+      password = opts.delete(:password)
+      if username || password
+        headers = (opts[:headers] || {}).dup
+        headers["Authorization"] ||= "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
+        opts[:headers] = headers
       end
+      opts
     end
   end
 end

data/lib/harpy/entry_point.rb

@@ -10,7 +10,7 @@ module Harpy
 
     def resource_url(resource_type)
       response = Harpy.client.get url
-      case response.code
+      case Harpy.client.response_status(response)
       when 200
         body = JSON.parse response.body
         link = (body["link"] || []).detect{|link| link["rel"] == resource_type}
@@ -22,9 +22,9 @@ module Harpy
 
     def urn(urn)
       response = Harpy.client.get "#{url}/#{urn}"
-      case response.code
+      case Harpy.client.response_status(response)
       when 301
-        response.headers_hash["Location"]
+        response.headers["location"]
       when 404
         nil
       else

data/lib/harpy/gem_version.rb

@@ -0,0 +1,14 @@
+module Harpy
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 0
+    PRE   = "preview1"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/harpy/resource.rb

@@ -16,6 +16,7 @@ module Harpy
       base.send :include, ActiveModel::Validations
       base.send :include, ActiveModel::Validations::Callbacks
       base.define_model_callbacks :save, :create, :update, :destroy, :only => [:before, :after]
+      base.send :include, InstanceMethods
     end
 
     def self.from_url(hash)
@@ -61,7 +62,7 @@ module Harpy
 
       def search(conditions={})
         response = Harpy.client.get url, :params => conditions
-        case response.code
+        case Harpy.client.response_status(response)
         when 200
           parsed = JSON.parse response.body
           items = parsed[resource_name].collect{|model| new model}
@@ -93,6 +94,14 @@ module Harpy
         delete_from_urn urn id
       end
 
+      def uman_attribute_name(attr, options = {})
+        attr
+      end
+
+      def lookup_ancestors
+        [self]
+      end
+
     private
 
       def url
@@ -100,7 +109,7 @@ module Harpy
       end
 
       def from_url_handler(response)
-        case response.code
+        case Harpy.client.response_status(response)
         when 200
           new JSON.parse response.body
         when 404
@@ -111,7 +120,7 @@ module Harpy
       end
 
       def delete_from_url_handler(response)
-        case response.code
+        case Harpy.client.response_status(response)
         when 204
           true
         when 404
@@ -122,128 +131,136 @@ module Harpy
       end
     end
 
-    def initialize(attrs = nil)
-      @attrs = {}
-      self.attributes = attrs || {}
-    end
+    module InstanceMethods
 
-    def attributes=(attrs)
-      attrs.each do |key, value|
-        if respond_to? "#{key}="
-          send "#{key}=", value
-        else
-          @attrs[key] = value
+      def initialize(attrs = nil)
+        @attrs = {}
+        self.attributes = attrs || {}
+      end
+
+      def attributes=(attrs)
+        attrs.each do |key, value|
+          if respond_to? "#{key}="
+            send "#{key}=", value
+          else
+            @attrs[key] = value
+          end
         end
       end
-    end
 
-    def as_json(*args)
-      hash = @attrs.dup
-      hash.delete "link"
-      hash.delete "urn"
-      hash
-    end
+      def as_json(*args)
+        hash = @attrs.dup
+        hash.delete "link"
+        hash.delete "urn"
+        hash
+      end
 
-    def save
-      if valid?
-        run_callbacks :save do
-          json = JSON.generate as_json
-          raise BodyToBig, "Size: #{json.bytesize} bytes (max 1MB)" if json.bytesize > 1.megabyte
-          persisted? ? update(json) : create(json)
+      def save
+        if valid?
+          run_callbacks :save do
+            json = JSON.generate as_json
+            raise BodyToBig, "Size: #{json.bytesize} bytes (max 1MB)" if json.bytesize > 1.megabyte
+            persisted? ? update(json) : create(json)
+          end
+        else
+          false
         end
-      else
-        false
       end
-    end
 
-    def destroy
-      raise Harpy::UrlRequired unless url
-      run_callbacks :destroy do
-        process_response Harpy.client.delete(url), :destroy
+      def destroy
+        raise Harpy::UrlRequired unless url
+        run_callbacks :destroy do
+          process_response Harpy.client.delete(url), :destroy
+        end
       end
-    end
 
-    def link(rel)
-      link = (@attrs["link"]||[]).detect{|l| l["rel"]==rel.to_s}
-      link["href"] if link
-    end
+      def link(rel)
+        link = (@attrs["link"]||[]).detect{|l| l["rel"]==rel.to_s}
+        link["href"] if link
+      end
 
-    def url
-      link "self"
-    end
+      def url
+        link "self"
+      end
 
-    def url_collection
-      Harpy.entry_point.resource_url self.class.resource_name
-    end
+      def url_collection
+        Harpy.entry_point.resource_url self.class.resource_name
+      end
 
-    def id
-      @attrs["urn"].split(":").last if @attrs["urn"]
-    end
+      def id
+        @attrs["urn"].split(":").last if @attrs["urn"]
+      end
 
-    def persisted?
-      @attrs["urn"].present?
-    end
+      def persisted?
+        @attrs["urn"].present?
+      end
 
-    def inspect
-      "<#{self.class.name} @attrs:#{@attrs.inspect} @errors:#{errors.full_messages.inspect} persisted:#{persisted?}>"
-    end
+      def inspect
+        "<#{self.class.name} @attrs:#{@attrs.inspect} @errors:#{errors.full_messages.inspect} persisted:#{persisted?}>"
+      end
 
-    def has_key?(key)
-      @attrs.has_key? key.to_s
-    end
+      def has_key?(key)
+        @attrs.has_key? key.to_s
+      end
 
-    def hash
-      urn.hash
-    end
+      def hash
+        urn.hash
+      end
 
-    def ==(other)
-      other.equal?(self) || (urn && other.instance_of?(self.class) && other.urn == urn)
-    end
-    alias_method :eql?, :==
+      def ==(other)
+        other.equal?(self) || (urn && other.instance_of?(self.class) && other.urn == urn)
+      end
+      alias_method :eql?, :==
 
-  private
+    private
 
-    def create(json)
-      run_callbacks :create do
-        process_response Harpy.client.post(url_collection, :body => json), :create
+      def create(json)
+        run_callbacks :create do
+          process_response Harpy.client.post(url_collection, :body => json), :create
+        end
       end
-    end
 
-    def update(json)
-      run_callbacks :update do
-        raise Harpy::UrlRequired unless url
-        process_response Harpy.client.put(url, :body => json), :update
+      def update(json)
+        run_callbacks :update do
+          raise Harpy::UrlRequired unless url
+          process_response Harpy.client.put(url, :body => json), :update
+        end
       end
-    end
 
-    def process_response(response, context)
-      case response.code
-      when 200, 201, 302
-        @attrs.merge! JSON.parse(response.body)
-        true
-      when 204
-        context==:create ? Harpy.client.invalid_code(response) : true
-      when 401
-        raise Harpy::Unauthorized, "Server returned a 401 response code"
-      when 422
-        JSON.parse(response.body)["errors"].each do |attr, attr_errors|
-          attr_errors.each{|attr_error| errors[attr] = attr_error }
+      def process_response(response, context)
+        case Harpy.client.response_status(response)
+        when 200, 201, 302
+          @attrs.merge! JSON.parse(response.body)
+          true
+        when 204
+          context==:create ? Harpy.client.invalid_code(response) : true
+        when 401
+          raise Harpy::Unauthorized, "Server returned a 401 response code"
+        when 422
+          JSON.parse(response.body)["errors"].each do |attr, attr_errors|
+            attr_errors.each{|attr_error| errors.add(attr, :invalid, message: attr_error) }
+          end
+          false
+        else
+          Harpy.client.invalid_code response
         end
-        false
-      else
-        Harpy.client.invalid_code response
       end
-    end
 
-    def method_missing(method, *args)
-      key = method.to_s
-      if persisted? && !@attrs.has_key?(key)
-        super
-      elsif key=~/[\]=]\z/
-        super
-      else
+      def read_attribute_for_validation(key)
         @attrs[key]
       end
+      public :read_attribute_for_validation
+
+      def method_missing(method, *args)
+        key = method.to_s
+        if persisted? && !@attrs.has_key?(key)
+          super
+        elsif key=~/[\]=]\z/
+          super
+        else
+          @attrs[key]
+        end
+      end
     end
   end
 end

data/lib/harpy/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "gem_version"
+
+module Harpy
+  def self.version
+    gem_version
+  end
+end

data/lib/harpy.rb

@@ -14,6 +14,7 @@ module Harpy
   autoload :Resource, "harpy/resource"
   autoload :BodyToBig, "harpy/resource"
   autoload :UnknownResponseCode, "harpy/resource"
+  autoload :VERSION, "harpy/gem_version"
 
   def self.client=(new_client)
     @client = new_client
@@ -38,10 +39,10 @@ module Harpy
   def self.entry_point
     @entry_point || raise(EntryPointRequired, 'you can setup one with Harpy.entry_point_url = "http://localhost"')
   end
-  
+
   def self.reset
     @client = nil
     @entry_point = nil
   end
 
-end
+end