telegraph_api_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f28d416ace8d594cc9d3606216af9c068b19aee
+  data.tar.gz: a434456de213c773c25503d46b2d38cfc8e60c11
+SHA512:
+  metadata.gz: ce55e60a6829482ee1e207046079aa0da4036a1676203cb18b6a4d640812649c37b37dc6aea69e20a83d1680127e66fe8ac51fd28ee8c8c16bc77a2dea92e633
+  data.tar.gz: c11c58522b360c7bf44ccf7c794e498b7c4a4a0df912a9fb6a517b5bdda58472129dfd4ace0ac86948ac74794da045a3170ba002033f6da45180191170366a1a

data/README.md

@@ -0,0 +1,57 @@
+# telegraph_api_ruby
+
+A Ruby interface to [Telegra.ph API](http://telegra.ph/api).
+
+## Installation
+
+Add following line to your Gemfile:
+
+```ruby
+gem 'telegraph_api_ruby'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it system-wide:
+
+```shell
+$ gem install telegraph_api_ruby
+```
+
+## Usage
+
+```ruby
+require 'telegraph_api_ruby'
+
+telegraph_access_token = 'YOUR_ACCESS_TOKEN'
+
+html = %(
+  <b>Hello World</b>
+)
+
+content = TelegraphApi::DomToNode.call(html)
+
+data = {
+  access_token: telegraph_access_token,
+  title: 'Test page',
+  content: JSON.dump(content),
+  return_content: true
+}
+
+result = TelegraphApi::Client.create_page(data)
+result.url
+```
+
+## Methods
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (git checkout -b feature/my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin feature/my-new-feature)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.ruby_opts = ['-W0'] # warnings level 0
+end
+
+desc 'Run tests'
+task default: :test

data/lib/telegraph_api_ruby/client.rb

@@ -0,0 +1,30 @@
+require 'active_support/inflector'
+
+require_relative 'types'
+
+module TelegraphApi
+  class Client
+    API_URL = 'https://api.telegra.ph/'.freeze
+
+    REQUEST_RESPONSE = {
+      create_account: Types::Account,
+      edit_account_info: Types::Account,
+      get_account_info: Types::Account,
+      revoke_access_token: Types::Account,
+      create_page: Types::Page,
+      edit_page: Types::Page,
+      get_page: Types::Page,
+      get_page_list: Types::PageList,
+      get_views: Types::PageViews
+    }.freeze
+
+    def self.method_missing(method, *args, &block)
+      path = ActiveSupport::Inflector.camelize(method.to_s, false)
+      Request.call(path, *args, REQUEST_RESPONSE[method.to_sym])
+    end
+
+    def self.respond_to_missing?(*)
+      super
+    end
+  end
+end

data/lib/telegraph_api_ruby/dom_to_node.rb

@@ -0,0 +1,48 @@
+require 'oga'
+
+module TelegraphApi
+  class DomToNode
+    attr_reader :data
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(data)
+      @data = data
+    end
+
+    def call
+      dom_to_node(parse_html(data))[:children]
+    end
+
+    private
+
+    def parse_html(data)
+      Oga.parse_html(data)
+    end
+
+    def dom_to_node(dom_node)
+      return dom_node.text if dom_node.is_a?(Oga::XML::Text)
+
+      node_element = {
+        children: []
+      }
+
+      if dom_node.is_a?(Oga::XML::Element)
+        node_element[:tag] = dom_node.name
+        node_element[:attrs] = {}
+
+        Array(dom_node.attributes).each do |attr|
+          node_element[:attrs][attr.name] = attr.value
+        end
+      end
+
+      Array(dom_node.children).each do |child|
+        node_element[:children].push(dom_to_node(child))
+      end
+
+      node_element
+    end
+  end
+end

data/lib/telegraph_api_ruby/request.rb

@@ -0,0 +1,44 @@
+require 'json'
+require 'typhoeus'
+
+module TelegraphApi
+  class Request
+    class ResponseError < StandardError; end
+
+    attr_reader :path, :opts, :response_schema
+
+    API_URL = 'https://api.telegra.ph/'.freeze
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(path, opts = {}, response_schema = nil)
+      @path = path
+      @opts = opts
+      @response_schema = response_schema
+    end
+
+    def call
+      result = request(path, opts)
+      response(result.body, response_schema)
+    end
+
+    private
+
+    def request(path, body)
+      Typhoeus.post("#{API_URL}/#{path}", body: body)
+    end
+
+    def response(data, type)
+      json = JSON.parse(data, symbolize_names: true)
+
+      if json[:ok] == true
+        result = json[:result]
+        (type && type[result]) || result
+      else
+        raise ResponseError, json[:error]
+      end
+    end
+  end
+end

data/lib/telegraph_api_ruby/types/account.rb

@@ -0,0 +1,16 @@
+require_relative 'struct'
+require_relative 'core'
+
+module TelegraphApi
+  module Types
+    class Account < Struct
+      attribute :short_name, Core::String
+      attribute :author_name, Core::String
+      attribute :author_url, Core::String
+
+      attribute :access_token, Core::String.meta(omittable: true)
+      attribute :auth_url, Core::String.meta(omittable: true)
+      attribute :page_count, Core::String.meta(omittable: true)
+    end
+  end
+end

data/lib/telegraph_api_ruby/types/core.rb

@@ -0,0 +1,10 @@
+require 'dry-struct'
+require 'dry-types'
+
+module TelegraphApi
+  module Types
+    class Core
+      include Dry::Types.module
+    end
+  end
+end

data/lib/telegraph_api_ruby/types/node.rb

@@ -0,0 +1,16 @@
+require_relative 'struct'
+require_relative 'core'
+
+module TelegraphApi
+  module Types
+    class NodeElement < Struct
+      Node = Core::String | NodeElement
+
+      attribute :tag, Core::String
+      attribute :attrs, Core::Hash
+      attribute :children, Core::Array.of(Node).meta(omittable: true)
+    end
+
+    Node = Core::String | NodeElement
+  end
+end

data/lib/telegraph_api_ruby/types/page.rb

@@ -0,0 +1,21 @@
+require_relative 'struct'
+require_relative 'core'
+require_relative 'node'
+
+module TelegraphApi
+  module Types
+    class Page < Struct
+      attribute :path, Core::String
+      attribute :url, Core::String
+      attribute :title, Core::String
+      attribute :description, Core::String
+      attribute :views, Core::Integer
+
+      attribute :author_name, Core::String.meta(omittable: true)
+      attribute :author_url, Core::String.meta(omittable: true)
+      attribute :image_url, Core::String.meta(omittable: true)
+      attribute :content, Core::Array.of(Node).meta(omittable: true)
+      attribute :can_edit, Core::Bool.meta(omittable: true)
+    end
+  end
+end

data/lib/telegraph_api_ruby/types/page_list.rb

@@ -0,0 +1,12 @@
+require_relative 'struct'
+require_relative 'core'
+require_relative 'page'
+
+module TelegraphApi
+  module Types
+    class PageList < Struct
+      attribute :total_count, Core::Integer
+      attribute :pages, Core::Array.of(Page)
+    end
+  end
+end

data/lib/telegraph_api_ruby/types/page_views.rb

@@ -0,0 +1,10 @@
+require_relative 'struct'
+require_relative 'core'
+
+module TelegraphApi
+  module Types
+    class PageViews < Struct
+      attribute :views, Core::Integer
+    end
+  end
+end

data/lib/telegraph_api_ruby/types/struct.rb

@@ -0,0 +1,25 @@
+require 'dry-struct'
+require 'dry-types'
+
+module TelegraphApi
+  module Types
+    class Struct < Dry::Struct
+      # throw an error when unknown keys provided
+      input input.strict
+
+      # convert string keys to symbols
+      transform_keys(&:to_sym)
+
+      # resolve default types on nil
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Core::Undefined : value
+          end
+        else
+          type
+        end
+      end
+    end
+  end
+end

data/lib/telegraph_api_ruby/types.rb

@@ -0,0 +1,6 @@
+require_relative 'types/core'
+require_relative 'types/account'
+require_relative 'types/node'
+require_relative 'types/page'
+require_relative 'types/page_list'
+require_relative 'types/page_views'

data/lib/telegraph_api_ruby.rb

@@ -0,0 +1,8 @@
+require_relative 'telegraph_api_ruby/types'
+require_relative 'telegraph_api_ruby/request'
+require_relative 'telegraph_api_ruby/client'
+require_relative 'telegraph_api_ruby/dom_to_node'
+
+module TelegraphApi
+  VERSION = '1.0.0'.freeze
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+ENV['APP_ENV'] = 'test'
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/reporters'
+Minitest::Reporters.use!
+
+require 'minitest/autorun'

data/test/test_telegraph_api.rb

@@ -0,0 +1,35 @@
+require_relative 'test_helper'
+
+class TestTelegraphApi < Minitest::Test
+  def test_create_user
+    result = create_account
+
+    refute_nil result.access_token, 'Access Token is nil'
+  end
+
+  def test_create_page
+    result = create_account
+
+    html = '<b>Test Content<u>sadasd</u></b><img src="123" />'
+    content = TelegraphApi::DomToNode.call(html)
+
+    data = {
+      access_token: result.access_token,
+      title: 'Test Title',
+      content: JSON.dump(content),
+      return_content: true
+    }
+
+    result = TelegraphApi::Client.create_page(data)
+
+    refute_nil result.content, 'Content is nil'
+    refute_nil result.url, 'Url is nil'
+  end
+
+  private
+
+  def create_account
+    data = { short_name: 'test' }
+    TelegraphApi::Client.create_account(data)
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: telegraph_api_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ivan Fokeev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !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.4
+  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.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: 
+email: vanya@vanya.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/telegraph_api_ruby.rb
+- lib/telegraph_api_ruby/client.rb
+- lib/telegraph_api_ruby/dom_to_node.rb
+- lib/telegraph_api_ruby/request.rb
+- lib/telegraph_api_ruby/types.rb
+- lib/telegraph_api_ruby/types/account.rb
+- lib/telegraph_api_ruby/types/core.rb
+- lib/telegraph_api_ruby/types/node.rb
+- lib/telegraph_api_ruby/types/page.rb
+- lib/telegraph_api_ruby/types/page_list.rb
+- lib/telegraph_api_ruby/types/page_views.rb
+- lib/telegraph_api_ruby/types/struct.rb
+- test/test_helper.rb
+- test/test_telegraph_api.rb
+homepage: http://github.com/ifokeev/telegraph_api_ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Fully working http client for https://telegra.ph/api supporting DomToNode
+  processing
+test_files: []