butter_cms_v2 0.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 395b22b381199739e45aed4ae138c57fc8f920cb8325f34bcbabbf77d17a8dfb
+  data.tar.gz: be0c935c0d182d5dc854b5ecd2a1f5c35163e767d28270daad12799e515c7a4d
+SHA512:
+  metadata.gz: 4b8f68fb55fc3119ec6b29cbf6584bb0c4070b92b443aa29d130a5518e1f2c85c50a9d9b28530b8b00eb8b5a784cf16a1c7948b14f7050a276314ac367e773ca
+  data.tar.gz: 5e04f885ee744e1bc24504063aa005085431fbabec9e4676a3323bf1ea65808680cce11f510355a6b4885320e7f007aca667891690aea0f197c8a5a96917524c

data/lib/butter_cms.rb

@@ -0,0 +1,34 @@
+require 'butter_cms/configuration'
+require 'butter_cms/url_params_service'
+require 'butter_cms/requests/api'
+require 'butter_cms/requests/get'
+require 'butter_cms/parsers/posts'
+require 'butter_cms/resource'
+require 'butter_cms/author'
+require 'butter_cms/parsers/author_object'
+require 'butter_cms/category'
+require 'butter_cms/parsers/categories_objects'
+require 'butter_cms/tag'
+require 'butter_cms/parsers/tags_objects'
+require 'butter_cms/post'
+require 'butter_cms/parsers/post_object'
+require 'butter_cms/posts_fetch_service'
+require 'butter_cms/parsers/categories'
+require 'butter_cms/parsers/post'
+
+module ButterCMS
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Returns the configuration class instance if block given
+  #
+  # @return [ButterCMS::Configuration]
+  def self.configure
+    self.configuration ||= ::ButterCMS::Configuration.new
+
+    yield(configuration) if block_given?
+  end
+end
+
+ButterCMS.configure unless ButterCMS.configuration

data/lib/butter_cms/author.rb

@@ -0,0 +1,5 @@
+module ButterCMS
+  class Author < ButterCMS::Resource
+
+  end
+end

data/lib/butter_cms/category.rb

@@ -0,0 +1,15 @@
+module ButterCMS
+  class Category < ButterCMS::Resource
+
+    # Returns all categories
+    #
+    # @return [Array<ButterCMS::Category>]
+    def self.all
+      response = ::ButterCMS::Requests::Get.call("categories")
+      attributes = ::ButterCMS::Parsers::Categories.new(response).categories
+
+      ::ButterCMS::Parsers::CategoriesObjects.call(attributes)
+    end
+
+  end
+end

data/lib/butter_cms/configuration.rb

@@ -0,0 +1,9 @@
+module ButterCMS
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = 'PLEASE PROVIDE VALID API KEY'
+    end
+  end
+end

data/lib/butter_cms/parsers/author_object.rb

@@ -0,0 +1,13 @@
+module ButterCMS
+  module Parsers
+    class AuthorObject
+      # Returns the new instance of author object from the given attributes
+      #
+      # @return [ButterCMS::Author]
+      def self.call(author)
+        ::ButterCMS::Author.new(author)
+      end
+
+    end
+  end
+end

data/lib/butter_cms/parsers/categories.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module ButterCMS
+  module Parsers
+    class Categories
+
+      def initialize(response)
+        @response = response
+      end
+
+      # Returns array of category attributes available in the response
+      #
+      # @return [Array]
+      def categories
+        parsed_json['data']
+      end
+
+      private
+
+      attr_reader :response
+
+      def parsed_json
+        @parsed_json ||= ::JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/butter_cms/parsers/categories_objects.rb

@@ -0,0 +1,15 @@
+module ButterCMS
+  module Parsers
+    class CategoriesObjects
+      # Returns array of category objects created from given array of attributes
+      #
+      # @return [Array<ButterCMS::Category>]
+      def self.call(categories)
+        categories.map do |category_attributes|
+          ::ButterCMS::Category.new(category_attributes)
+        end
+      end
+
+    end
+  end
+end

data/lib/butter_cms/parsers/post.rb

@@ -0,0 +1,12 @@
+module ButterCMS
+  module Parsers
+    class Post < ButterCMS::Parsers::Posts
+      # Returns post attributes
+      #
+      # @return [Hash]
+      def post
+        parsed_json['data']
+      end
+    end
+  end
+end

data/lib/butter_cms/parsers/post_object.rb

@@ -0,0 +1,19 @@
+module ButterCMS
+  module Parsers
+    class PostObject
+      # Returns the new instance of post with the associations included
+      #
+      # @return [ButterCMS::Post]
+      def self.call(post_attributes)
+        updated_post_attributes = {
+          'tags' => ::ButterCMS::Parsers::TagsObjects.call(post_attributes.delete('tags')),
+          'categories' => ::ButterCMS::Parsers::CategoriesObjects.call(post_attributes.delete('categories')),
+          'author' => ::ButterCMS::Parsers::AuthorObject.call(post_attributes.delete('author'))
+        }
+
+        ::ButterCMS::Post.new(post_attributes.merge(updated_post_attributes))
+      end
+
+    end
+  end
+end

data/lib/butter_cms/parsers/posts.rb

@@ -0,0 +1,48 @@
+require 'json'
+
+module ButterCMS
+  module Parsers
+    class Posts
+
+      def initialize(response)
+        @response = response
+      end
+
+      # Returns the number of the next page or nil if not available
+      #
+      # @return [String]
+      def next_page
+        parsed_json['meta']['next_page']
+      end
+
+      # Returns the number of the previous page or nil if not available
+      #
+      # @return [String]
+      def previous_page
+        parsed_json['meta']['previous_page']
+      end
+
+      # Returns the count of existing posts
+      #
+      # @return [String]
+      def count
+        parsed_json['meta']['count']
+      end
+
+      # Returns array of posts attributes available in the response
+      #
+      # @return [Array]
+      def posts
+        parsed_json['data']
+      end
+
+      private
+
+      attr_reader :response
+
+      def parsed_json
+        @parsed_json ||= ::JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/butter_cms/parsers/tags_objects.rb

@@ -0,0 +1,15 @@
+module ButterCMS
+  module Parsers
+    class TagsObjects
+      # Returns array of tag objects created from given array of attributes
+      #
+      # @return [Array<ButterCMS::Tag>]
+      def self.call(tags)
+        tags.map do |tag_attributes|
+          ::ButterCMS::Tag.new(tag_attributes)
+        end
+      end
+
+    end
+  end
+end

data/lib/butter_cms/post.rb

@@ -0,0 +1,34 @@
+module ButterCMS
+  class Post < ButterCMS::Resource
+    class RecordNotFound < StandardError; end
+    # Returns post for given slug if available otherwise raises error RecordNotFound
+    #
+    # @return [ButterCMS::Post]
+    def self.all
+      posts = []
+      request_options = { page_size: 10, page: 0 }
+      more_posts = true
+
+      while more_posts
+        request_options = request_options.merge(page: request_options[:page] + 1)
+        fetch_service = ButterCMS::PostsFetchService.new(request_options)
+        posts = posts | fetch_service.posts
+        more_posts = fetch_service.more_posts?
+      end
+
+      posts
+    end
+
+    # Returns all available posts from the API
+    #
+    # @return [ButterCMS::Post]
+    def self.find(slug)
+      response = ::ButterCMS::Requests::Get.call("posts/#{slug}")
+      post_attributes = ::ButterCMS::Parsers::Post.new(response).post
+      ::ButterCMS::Parsers::PostObject.call(post_attributes)
+    rescue RestClient::NotFound
+      raise RecordNotFound
+    end
+
+  end
+end

data/lib/butter_cms/posts_fetch_service.rb

@@ -0,0 +1,35 @@
+module ButterCMS
+  class PostsFetchService
+    def initialize(request_options)
+      @request_options = request_options
+    end
+
+    # Returns array of post objects with the associated records included
+    #
+    # @return [Array<ButterCMS::Post>]
+    def posts
+      parser.posts.map do |post_attributes|
+        ::ButterCMS::Parsers::PostObject.call(post_attributes)
+      end
+    end
+
+    # Returns true if the next page is available, false otherwise
+    #
+    # @return [Boolean]
+    def more_posts?
+      !parser.next_page.nil?
+    end
+
+    private
+
+    attr_reader :request_options
+
+    def response
+      ::ButterCMS::Requests::Get.call("posts", request_options)
+    end
+
+    def parser
+      @parser ||= ::ButterCMS::Parsers::Posts.new(response)
+    end
+  end
+end

data/lib/butter_cms/requests/api.rb

@@ -0,0 +1,7 @@
+module ButterCMS
+  module Requests
+    module API
+      URL = "https://api.buttercms.com/v2/".freeze
+    end
+  end
+end

data/lib/butter_cms/requests/get.rb

@@ -0,0 +1,22 @@
+require 'rest_client'
+
+module ButterCMS
+  module Requests
+    class Get
+
+      # Returns response from the request to the given API endpoint
+      #
+      # @return [RestClient::Response]
+      def self.call(path, options = {})
+        full_url = [
+          ::ButterCMS::Requests::API::URL,
+          path,
+          ::ButterCMS::UrlParamsService.call(options)
+        ].join
+
+        ::RestClient.get(full_url)
+      end
+
+    end
+  end
+end

data/lib/butter_cms/resource.rb

@@ -0,0 +1,9 @@
+module ButterCMS
+  class Resource
+    def initialize(attributes = {})
+      attributes.each do |attr, value|
+        define_singleton_method(attr) { attributes[attr] }
+      end
+    end
+  end
+end

data/lib/butter_cms/tag.rb

@@ -0,0 +1,5 @@
+module ButterCMS
+  class Tag < ButterCMS::Resource
+
+  end
+end

data/lib/butter_cms/url_params_service.rb

@@ -0,0 +1,14 @@
+module ButterCMS
+  class UrlParamsService
+
+    # Returns the query part of the request to the API
+    #
+    # @return [String]
+    def self.call(options = {})
+      options[:auth_token] = ButterCMS.configuration.api_key
+
+      "?" << options.map { |(key, value)| "#{key.to_s}=#{value}" }.join("&")
+    end
+
+  end
+end

data/lib/butter_cms/version.rb

@@ -0,0 +1,12 @@
+module ButterCMS
+  module Version
+    module_function
+
+    # Gem current version
+    #
+    # @return [String]
+    def to_s
+      "0.0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: butter_cms_v2
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1
+platform: ruby
+authors:
+- Paweł Dąbrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email: dziamber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/butter_cms.rb
+- lib/butter_cms/author.rb
+- lib/butter_cms/category.rb
+- lib/butter_cms/configuration.rb
+- lib/butter_cms/parsers/author_object.rb
+- lib/butter_cms/parsers/categories.rb
+- lib/butter_cms/parsers/categories_objects.rb
+- lib/butter_cms/parsers/post.rb
+- lib/butter_cms/parsers/post_object.rb
+- lib/butter_cms/parsers/posts.rb
+- lib/butter_cms/parsers/tags_objects.rb
+- lib/butter_cms/post.rb
+- lib/butter_cms/posts_fetch_service.rb
+- lib/butter_cms/requests/api.rb
+- lib/butter_cms/requests/get.rb
+- lib/butter_cms/resource.rb
+- lib/butter_cms/tag.rb
+- lib/butter_cms/url_params_service.rb
+- lib/butter_cms/version.rb
+homepage: http://github.com/rubyhero/butter_cms
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the ButterCMS API
+test_files: []