telegraph_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b61c1a5fd39393ce238a4b69829336826ed61e67
+  data.tar.gz: e34cdf83ef2fd93a71ed94ceca07b396c2d6ca68
+SHA512:
+  metadata.gz: 2b9c155a09fe8870b47e8cc8102384a550f5635ef479fbabe08d5f0f462f1aa0b53a48358ab5c390b8d06335b139123aacf6be06b55ea744473cf5e3ed5b9ed0
+  data.tar.gz: 577505c5809ddb8dae6a2a2cecfb892f4ae699283b20c5dff01559be24b1e095fc0f6f9b4a66ea312f21f3ac109da872c96bc8461408ab3f251abec7a7d60d65

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.idea

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in telegraph_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sergey Malenkov
+
+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,41 @@
+# TelegraphApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/telegraph_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telegraph_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telegraph_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/telegraph_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "telegraph_api"
+
+# 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/telegraph/api/account.rb

@@ -0,0 +1,29 @@
+module Telegraph
+  module Account
+    def self.create(params)
+      return nil unless CreateAccountSchema.(params).success?
+      response = Telegraph::Core.request('createAccount', params)
+      Types::Account.new(Hashie.symbolize_keys response['result'])
+    end
+
+    def self.edit(params)
+      return nil unless EditAccountInfoSchema.(params).success?
+      response = Telegraph::Core.request('editAccountInfo', params)
+      Types::Account.new(Hashie.symbolize_keys response['result'])
+    end
+
+    def self.info(params)
+      return nil unless GetAccountInfoSchema.(params).success?
+      params[:fields] = params[:fields].to_s
+      response = Telegraph::Core.request('getAccountInfo', params)
+      Types::Account.new(Hashie.symbolize_keys response['result'])
+    end
+
+    def self.revoke_token(params)
+      return nil unless RevokeAccessTokenSchema.(params).success?
+      response = Telegraph::Core.request('revokeAccessToken', params)
+      return response['error'] if response['error']
+      Types::Account.new(Hashie.symbolize_keys response['result'])
+    end
+  end
+end

data/lib/telegraph/api/core.rb

@@ -0,0 +1,17 @@
+require 'pp'
+module Telegraph
+  module Core
+    def self.request(method, params = {})
+      conn = Faraday.new(
+          :url => 'https://api.telegra.ph',
+          request: { params_encoder: Faraday::FlatParamsEncoder }
+      )
+      conn.response :json
+
+      response = conn.get('/' + method) do |request|
+        request.params.merge!(params)
+      end
+      response.body
+    end
+  end
+end

data/lib/telegraph/api/page.rb

@@ -0,0 +1,42 @@
+module Telegraph
+  module Page
+    def self.create(params)
+      return nil unless CreatePageSchema.(params).success?
+      response = Telegraph::Core.request('createPage', params)
+      if response.dig('result', 'content')
+        response['result']['content'] = Types::Page.new(Hashie.symbolize_keys response['result'])
+      end
+      response
+    end
+
+    def self.edit(params)
+      return nil unless EditPageSchema.(params).success?
+      path = params.delete(:path)
+      response = Telegraph::Core.request('editPage/' + path, params)
+      if response.dig('result', 'content')
+        response['result']['content'] = Types::Page.new(Hashie.symbolize_keys response['result'])
+      end
+      response
+    end
+
+    def self.get(params)
+      return nil unless GetPageSchema.(params).success?
+      path = params.delete(:path)
+      response = Telegraph::Core.request('getPage/' + path, params)
+      Types::Page.new(Hashie.symbolize_keys response['result'])
+    end
+
+    def self.list(params)
+      return nil unless GetPageListSchema.(params).success?
+      response = Telegraph::Core.request('getPageList', params)
+      Types::PageList.new(Hashie.symbolize_keys response['result'])
+    end
+
+    def self.views(params)
+      return nil unless GetViewsSchema.(params).success?
+      path = params.delete(:path)
+      response = Telegraph::Core.request('getViews/' + path, params)
+      Types::PageViews.new(Hashie.symbolize_keys response['result'])
+    end
+  end
+end

data/lib/telegraph/api/version.rb

@@ -0,0 +1,5 @@
+module Telegraph
+  module Api
+    VERSION = '0.1.0'
+  end
+end

data/lib/telegraph/api.rb

@@ -0,0 +1,3 @@
+require 'telegraph/api/core'
+require 'telegraph/api/page'
+require 'telegraph/api/account'

data/lib/telegraph/types/account.rb

@@ -0,0 +1,20 @@
+module Telegraph
+  module Types
+    class Account < Base
+      attribute :short_name, String
+      attribute :author_name, String
+      attribute :author_url, String
+      attribute :access_token, String
+      attribute :auth_url, String
+      attribute :page_count, Integer
+
+      SHORT_NAME = 'short_name'
+      AUTHOR_NAME = 'author_name'
+      AUTHOR_URL = 'author_url'
+      AUTH_URL = 'auth_url'
+      PAGE_COUNT = 'page_count'
+
+      FIELDS = [SHORT_NAME, AUTHOR_NAME, AUTHOR_URL, AUTH_URL, PAGE_COUNT]
+    end
+  end
+end

data/lib/telegraph/types/base.rb

@@ -0,0 +1,7 @@
+module Telegraph
+  module Types
+    class Base
+      include Virtus.model
+    end
+  end
+end

data/lib/telegraph/types/node.rb

@@ -0,0 +1,19 @@
+module Telegraph
+  module Types
+    class Node
+      include Virtus.model
+      attribute :tag, String
+      attribute :attr, String
+      attribute :children, Array[Node]
+      attribute :text, String
+
+      def initialize(node)
+        if node.is_a?(String)
+          @text = node
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/telegraph/types/node_element.rb

@@ -0,0 +1,9 @@
+module Telegraph
+  module Types
+    class NodeElement < Base
+      attribute :tag, String
+      attribute :attr, String
+      attribute :children, Array[Telegraph::Types::Node]
+    end
+  end
+end

data/lib/telegraph/types/page.rb

@@ -0,0 +1,16 @@
+module Telegraph
+  module Types
+    class Page < Base
+      attribute :path, String
+      attribute :url, String
+      attribute :title, String
+      attribute :description, String
+      attribute :author_name, String
+      attribute :author_url, String
+      attribute :image_url, String
+      attribute :content, Array[Node]
+      attribute :views, Integer
+      attribute :can_edit, Axiom::Types::Boolean
+    end
+  end
+end

data/lib/telegraph/types/page_list.rb

@@ -0,0 +1,8 @@
+module Telegraph
+  module Types
+    class PageList < Base
+      attribute :total_count, Integer
+      attribute :pages, Array[Page]
+    end
+  end
+end

data/lib/telegraph/types/page_views.rb

@@ -0,0 +1,7 @@
+module Telegraph
+  module Types
+    class PageViews < Base
+      attribute :views, Integer
+    end
+  end
+end

data/lib/telegraph/types.rb

@@ -0,0 +1,7 @@
+require 'telegraph/types/base'
+require 'telegraph/types/account'
+require 'telegraph/types/node'
+require 'telegraph/types/node_element'
+require 'telegraph/types/page'
+require 'telegraph/types/page_list'
+require 'telegraph/types/page_views'

data/lib/telegraph/validations/account.rb

@@ -0,0 +1,31 @@
+module Telegraph
+  module Account
+    CreateAccountSchema = Dry::Validation.Schema do
+      required(:short_name) { str? & size?(1..32) }
+      optional(:author_name) { str? & size?(0..128) }
+      optional(:author_url) { str? & size?(0..512) }
+    end
+
+    EditAccountInfoSchema = Dry::Validation.Schema do
+      required(:access_token) { str? }
+      optional(:short_name) { str? & size?(1..32) }
+      optional(:author_name) { str? & size?(0..128) }
+      optional(:author_url) { str? & size?(0..512) }
+    end
+
+    GetAccountInfoSchema = Dry::Validation.Schema do
+      configure do
+        def valid_fields?(value)
+          (value - Telegraph::Types::Account::FIELDS).empty?
+        end
+      end
+
+      required(:access_token) { str? }
+      optional(:fields) { valid_fields? }
+    end
+
+    RevokeAccessTokenSchema = Dry::Validation.Schema do
+      required(:access_token) { str? }
+    end
+  end
+end

data/lib/telegraph/validations/page.rb

@@ -0,0 +1,39 @@
+module Telegraph
+  module Page
+    class CommonPageSchema < Dry::Validation::Schema
+      define! do
+        required(:access_token) { str? & filled? }
+        required(:title) { str? & min_size?(1) & max_size?(256) }
+        optional(:author_name) { str? & max_size?(128) }
+        optional(:author_url) { str? & max_size?(512) }
+        required(:content) { str? & filled? & max_size?(64 * 1024 * 1024) }
+        optional(:return_content) { bool? }
+      end
+    end
+
+    CreatePageSchema = Dry::Validation.Schema(CommonPageSchema)
+
+    EditPageSchema = Dry::Validation.Schema(CommonPageSchema) do
+      required(:path) { str? & filled? }
+    end
+
+    GetPageSchema = Dry::Validation.Schema do
+      required(:path) { str? & filled? }
+      optional(:return_content) { bool? }
+    end
+
+    GetPageListSchema = Dry::Validation.Schema do
+      required(:access_token) { str? & filled? }
+      optional(:offset) { int? }
+      optional(:limit) { int? & size?(0..200) }
+    end
+
+    GetViewsSchema = Dry::Validation.Schema do
+      required(:path) { str? & filled? }
+      required(:year) { int? & included_in?(2000..2100) }
+      required(:month) { int? & included_in?(1..12) }
+      optional(:day) { int? & included_in?(1..31) }
+      optional(:hour) { int? & included_in?(0..24) }
+    end
+  end
+end

data/lib/telegraph/validations.rb

@@ -0,0 +1,2 @@
+require 'telegraph/validations/page'
+require 'telegraph/validations/account'

data/lib/telegraph_api.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+require 'faraday'
+require 'faraday_middleware'
+require 'dry-validation'
+require 'hashie'
+
+require 'telegraph/api/version'
+require 'telegraph/api'
+require 'telegraph/types'
+require 'telegraph/validations'
+
+module Telegraph
+end

data/telegraph_api.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telegraph/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telegraph_api"
+  spec.version       = Telegraph::Api::VERSION
+  spec.authors       = ["Sergey Malenkov"]
+  spec.email         = ["def.sergey@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for Telegra.ph API}
+  spec.description   = %q{Gem for wrapping Telegraph API}
+  spec.homepage      = "https://github.com/deff7/telegraph_api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'virtus'
+  spec.add_dependency 'dry-validation'
+  spec.add_dependency 'hashie'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: telegraph_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Malenkov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  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: Gem for wrapping Telegraph API
+email:
+- def.sergey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/telegraph/api.rb
+- lib/telegraph/api/account.rb
+- lib/telegraph/api/core.rb
+- lib/telegraph/api/page.rb
+- lib/telegraph/api/version.rb
+- lib/telegraph/types.rb
+- lib/telegraph/types/account.rb
+- lib/telegraph/types/base.rb
+- lib/telegraph/types/node.rb
+- lib/telegraph/types/node_element.rb
+- lib/telegraph/types/page.rb
+- lib/telegraph/types/page_list.rb
+- lib/telegraph/types/page_views.rb
+- lib/telegraph/validations.rb
+- lib/telegraph/validations/account.rb
+- lib/telegraph/validations/page.rb
+- lib/telegraph_api.rb
+- telegraph_api.gemspec
+homepage: https://github.com/deff7/telegraph_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Telegra.ph API
+test_files: []