dev_ruby 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c97ff734180da46570fffd2b2cbf21b6c4b43ab1fb776a9c5bc6961581286dd6
-  data.tar.gz: bd6d656db14a79f310e2428aeecc3df77382488879c1fec011045334284124ef
+  metadata.gz: c72c665418cd3f98071b63f5192ca1b74bc1b0cb3805baf8bcb0908de56f5dc0
+  data.tar.gz: 3634d40cf94496c311baaac15b82262d05c7a171eb1e72ebcd6db0287eb1da30
 SHA512:
-  metadata.gz: 24293c5d54863cf0743d08117a071ebe5f52bcd2cc5807fb428b390c85ffb0f8bb32b0c1ff035e519bfaf6f1cb3147dc17f21dc13a7e258d31740f9de0414688
-  data.tar.gz: 68fdd8fac1d3211556cd7c79a5389acd4e240e30ee68f82c218c08fffb322b93302d27126680aed885a9c1e07d8b313d24d54ef25bf231ee6aa2082e5862a04c
+  metadata.gz: e9b600c9fbff1e4f974641774ea691153d6b177f7e6ba924895fd2f3ad581193a7e0374c586eef5317f51b8589df73ed2912605529a626ad91c9a5dfa484aad4
+  data.tar.gz: 1ff3ba0012d7a8cc59cf0a8daf8fcb655befa2f197ceaceadb5bee7900e1b0aefc84bacf8df7deeb81c752f925ca4670c2fc7faba79d5a2c022df2572a61c5ca

data/Gemfile

@@ -10,3 +10,12 @@ gem 'rake', '~> 13.0'
 gem 'minitest', '~> 5.0'
 
 gem 'rubocop', '~> 1.21'
+
+# HTTP/REST API client library [https://github.com/lostisland/faraday]
+gem 'faraday', '~> 2.2'
+
+# Common monads for Ruby [https://github.com/dry-rb/dry-monads]
+gem 'dry-monads', '~> 1.4'
+
+# Pretty print Ruby objects with proper indentation and colors [https://github.com/awesome-print/awesome_print]
+gem 'awesome_print'

data/Gemfile.lock

@@ -7,6 +7,17 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    awesome_print (1.9.2)
+    concurrent-ruby (1.1.10)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-monads (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.7)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.2)
     minitest (5.15.0)
     parallel (1.22.1)
     parser (3.1.2.0)
@@ -27,13 +38,17 @@ GEM
     rubocop-ast (1.17.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     unicode-display_width (2.1.0)
 
 PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  awesome_print
   dev_ruby!
+  dry-monads (~> 1.4)
+  faraday (~> 2.2)
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)

data/lib/dev_ruby/client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DevRuby
+  class Client
+    BASE_URL = 'https://dev.to/api'
+    API_KEY = 'api-key'
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def articles
+      DevRuby::Resources::ArticlesResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.headers[API_KEY] = api_key
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+        conn.adapter adapter, @stubs
+      end
+    end
+  end
+end

data/lib/dev_ruby/collection.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevRuby
+  class Collection
+    attr_reader :page, :per_page, :next_page, :prev_page, :data
+
+    def self.from_response(response:, type:, params:)
+      new(data: response.body.map { |attrs| type.new(attrs) },
+          page: params[:page],
+          per_page: params[:per_page])
+    end
+
+    def initialize(data:, page:, per_page:)
+      @data = data
+      @page = page
+      @per_page = per_page
+      @next_page = data.count.positive? ? (page + 1) : nil
+      @prev_page = page.positive? ? (page - 1) : nil
+    end
+  end
+end

data/lib/dev_ruby/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DevRuby
+  class Error < StandardError; end
+end

data/lib/dev_ruby/helpers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevRuby
+  class Helpers
+    class << self
+      def expected_response?(response, expected_status)
+        response.status == expected_status
+      end
+    end
+  end
+end

data/lib/dev_ruby/objects/article.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DevRuby
+  module Objects
+    class Article < BaseObject
+    end
+  end
+end

data/lib/dev_ruby/objects/base_object.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module DevRuby
+  module Objects
+    class BaseObject < OpenStruct
+      def initialize(attributes)
+        super to_ostruct(attributes)
+      end
+
+      def to_ostruct(obj)
+        case obj
+        when Hash
+          OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })
+        when Array
+          obj.map { |o| to_ostruct(o) }
+        else # Assumed to be a primitive value
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/dev_ruby/resources/articles_resource.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ClassLength
+module DevRuby
+  module Resources
+    class ArticlesResource < BaseResource
+      attr_reader :client
+
+      def published(**params)
+        params = to_default_pagination_params(params)
+
+        response = get_request('articles', params: params)
+
+        if Helpers.expected_response?(response, 200)
+          collection = Collection.from_response(response: response,
+                                                type: DevRuby::Objects::Article,
+                                                params: params)
+
+          Success(collection)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def create(**body)
+        response = post_request('articles', body: { article: body })
+
+        if Helpers.expected_response?(response, 201)
+          article = DevRuby::Objects::Article.new(response.body)
+
+          Success(article)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def latest_published(**params)
+        params = to_default_pagination_params(params)
+
+        response = get_request('articles/latest', params: params)
+
+        if Helpers.expected_response?(response, 200)
+          collection = Collection.from_response(response: response,
+                                                type: DevRuby::Objects::Article,
+                                                params: params)
+
+          Success(collection)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def find(id)
+        response = get_request("articles/#{id}")
+
+        if Helpers.expected_response?(response, 200)
+          article = DevRuby::Objects::Article.new(response.body)
+
+          Success(article)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def update(id, **body)
+        response = put_request("articles/#{id}", body: { article: body })
+
+        if Helpers.expected_response?(response, 200)
+          article = DevRuby::Objects::Article.new(response.body)
+
+          Success(article)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def find_by_path(username:, slug:)
+        response = get_request("articles/#{username}/#{slug}")
+
+        if Helpers.expected_response?(response, 200)
+          article = DevRuby::Objects::Article.new(response.body)
+
+          Success(article)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def me
+        response = get_request('articles/me')
+
+        if Helpers.expected_response?(response, 200)
+          article = DevRuby::Objects::Article.new(response.body)
+
+          Success(article)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def me_published(**params)
+        params = to_default_pagination_params(params)
+
+        response = get_request('articles/me/published', params: params)
+
+        if Helpers.expected_response?(response, 200)
+          collection = Collection.from_response(response: response,
+                                                type: DevRuby::Objects::Article,
+                                                params: params)
+
+          Success(collection)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def me_unpublished(**params)
+        params = to_default_pagination_params(params)
+
+        response = get_request('articles/me/unpublished', params: params)
+
+        if Helpers.expected_response?(response, 200)
+          collection = Collection.from_response(response: response,
+                                                type: DevRuby::Objects::Article,
+                                                params: params)
+
+          Success(collection)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def me_all(**params)
+        params = to_default_pagination_params(params)
+
+        response = get_request('articles/me/all', params: params)
+
+        if Helpers.expected_response?(response, 200)
+          collection = Collection.from_response(response: response,
+                                                type: DevRuby::Objects::Article,
+                                                params: params)
+
+          Success(collection)
+        else
+          Failure(error_parser(response))
+        end
+      end
+
+      def videos(**params)
+        params = to_default_pagination_params(params)
+
+        response = get_request('videos', params: params)
+
+        if Helpers.expected_response?(response, 200)
+          collection = Collection.from_response(response: response,
+                                                type: DevRuby::Objects::Article,
+                                                params: params)
+
+          Success(collection)
+        else
+          Failure(error_parser(response))
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/dev_ruby/resources/base_resource.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'dry/monads'
+
+module DevRuby
+  module Resources
+    class BaseResource
+      include Dry::Monads[:result]
+
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      private
+
+      def get_request(url, params: {}, headers: {})
+        client.connection.get(url, params, headers)
+      end
+
+      def post_request(url, body:, headers: {})
+        client.connection.post(url, body, headers)
+      end
+
+      def patch_request(url, body:, headers: {})
+        client.connection.patch(url, body, headers)
+      end
+
+      def put_request(url, body:, headers: {})
+        client.connection.put(url, body, headers)
+      end
+
+      def delete_request(url, params: {}, headers: {})
+        client.connection.delete(url, params, headers)
+      end
+
+      def error_parser(response)
+        OpenStruct.new(status: response.status, body: response.body)
+      end
+
+      def to_default_pagination_params(params)
+        params[:page] ||= 1
+        params[:per_page] ||= 20
+        params
+      end
+    end
+  end
+end

data/lib/dev_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DevRuby
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

data/lib/dev_ruby.rb

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
+require 'faraday'
+require 'awesome_print'
 require_relative 'dev_ruby/version'
 
 module DevRuby
-  class Error < StandardError; end
-  # Your code goes here...
+  require_relative 'dev_ruby/helpers'
+  require_relative 'dev_ruby/error'
+  require_relative 'dev_ruby/client'
+  require_relative 'dev_ruby/collection'
+
+  # Resources
+  require_relative 'dev_ruby/resources/base_resource'
+  require_relative 'dev_ruby/resources/articles_resource'
+
+  # Objects
+  require_relative 'dev_ruby/objects/base_object'
+  require_relative 'dev_ruby/objects/article'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - nejdetkadir
@@ -27,6 +27,14 @@ files:
 - Rakefile
 - dev_ruby.gemspec
 - lib/dev_ruby.rb
+- lib/dev_ruby/client.rb
+- lib/dev_ruby/collection.rb
+- lib/dev_ruby/error.rb
+- lib/dev_ruby/helpers.rb
+- lib/dev_ruby/objects/article.rb
+- lib/dev_ruby/objects/base_object.rb
+- lib/dev_ruby/resources/articles_resource.rb
+- lib/dev_ruby/resources/base_resource.rb
 - lib/dev_ruby/version.rb
 - sig/dev_ruby.rbs
 homepage: https://github.com/nejdetkadir/dev-ruby