mstdn_ivory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0cf8aed270448aa92b0e04f2547efbe3e6b104e56aeb0aead7a0c8bcfa77fc1
+  data.tar.gz: c19de6c6a50b95cfcb50e3a5f2e8bc679927bebc63890ba8716677cb0fb148b8
+SHA512:
+  metadata.gz: c50f4b837947eff948157bdc6c9fa03a3fca76b036d4a94c6e7ce839c805cbc35afb0aac2f084c814c55b52af00f981fe22c6ea5f88a9392ee344ec21d841c19
+  data.tar.gz: 8fae8724301ed92af7a1db4cee310c245fe1b66e9cdb1255a3c8206916ff93dd69e0834ca82574d78b0612aeeb64a485a5a44b739a68c0a35287fed119a8777b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sa2taka@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mstdn_ivory.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    mstdn_ivory (0.1.0)
+      http (~> 3.3)
+      oauth2 (~> 1.4)
+      oj (~> 3.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.0)
+    http_parser.rb (0.6.0)
+    jwt (1.5.6)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    oj (3.5.1)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mstdn_ivory!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 sa2taka
+
+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,93 @@
+# MstdnIvory
+
+Ruby interface for Mastodon api, like mastodon-api npm package
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mstdn_ivory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mstdn_ivory
+
+## Usage
+
+#### authorization
+For getting access token(and creating app):
+
+```ruby
+require 'mstdn_ivory'
+
+client = MstdnIvory::Client.new('baseurl(e.g. https://mstdn-workers.com)')
+res = client.create_app('app name',
+                        'scopes(e.g. read write follow, default scope is read)',
+                        'redirect_uri, default is urn:ietf:wg:oauth:2.0:oob',
+                        'website name, default is nil')
+res.client_id # => 'Your client id'
+res.client_secret # => 'Your client secret'
+
+auth_url = client.create_authorization_url(res.client_id,
+                                          res.client_secret,
+                                          'Your client scopes',
+                                          'redirect_uri, default is urn:ietf:wg:oauth:2.0:oob')
+auth_url #=> 'https://mstdn-workers.com/oauth/authorize...'
+
+# You got authorization_code in some way
+token = client.get_access_token(res.client_id,
+                                res.client_secret,
+                                'Your authorization code',
+                                'redirect_uri, default is urn:ietf:wg:oauth:2.0:oob')
+token #=> 'Your access token'
+
+client.get('/api/v1/accounts/424') # => Information of my accounts(If there is in mstdn-workers.com)
+```
+
+If you already have access token, you can easily create client:
+
+```ruby
+client = MstdnIvory::Client.new('baseurl', 'Your access token')
+client.get('/api/v1/accounts/424') # => Information of my accounts
+```
+
+#### examples
+
+You can get and post method using client.
+
+For example, Reading the home timeline:
+
+```ruby
+client.get('/api/v1/timelines/home')
+```
+
+Post status:
+```ruby
+client.post('/api/v1/statuses', {'status': 'status content'})
+```
+
+
+
+## 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]/mstdn_ivory. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MstdnIvory project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mstdn_ivory/blob/master/CODE_OF_CONDUCT.md).

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 "mstdn_ivory"
+
+# 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/mstdn_ivory/api.rb

@@ -0,0 +1,11 @@
+require 'mstdn_ivory/register'
+require 'mstdn_ivory/request'
+require 'mstdn_ivory/rest'
+
+module MstdnIvory
+  module Api
+    include MstdnIvory::Register
+    include MstdnIvory::Request
+    include MstdnIvory::Rest
+  end
+end

data/lib/mstdn_ivory/client.rb

@@ -0,0 +1,27 @@
+require 'mstdn_ivory/api'
+
+module MstdnIvory
+  class Client
+    include Api
+
+    attr_accessor :token
+    attr_reader :base_url
+    attr_reader :timeout
+
+    DEFAULT_TIMEOUT = { connect: 2, read: 5, write: 20 }
+
+    def initialize(base_url, token = '', options = {})
+      @base_url = base_url
+      @token = token
+      @timeout = DEFAULT_TIMEOUT.merge(options[:timeout] || {})
+    end
+
+    def headers
+      {
+        accept: '*/*',
+        user_agent:'mstdn ivory',
+        authorization: "Bearer #{@token}"
+      }
+    end
+  end
+end

data/lib/mstdn_ivory/dot_accessable_hash.rb

@@ -0,0 +1,19 @@
+module MstdnIvory
+  # This class inherit hash.
+  # The value is accessed by key name method:
+  #   dah = DotAccessableHash.new
+  #   dah['strkey'] = 'strvalue'
+  #   dah[:symkey] = :symkey
+  #   dah.strkey # => "strvalue"
+  #   dah.symkey # => :symkey
+  class DotAccessableHash < Hash
+    def method_missing(name)
+      super unless self.has_key?(name) || self.has_key?(name.to_s)
+      self[name.to_s] || self[name]
+    end
+
+    def respond_to_missing?(name)
+      return self.has_key?(name) || self.has_key?(name.to_s)
+    end
+  end
+end

data/lib/mstdn_ivory/register.rb

@@ -0,0 +1,19 @@
+require 'oauth2'
+
+module MstdnIvory
+  module Register
+    def create_app(name, scopes = 'read', redirect_uri = 'urn:ietf:wg:oauth:2.0:oob', website = nil)
+      request(:post, '/api/v1/apps', { client_name: name, redirect_uris: redirect_uri, scopes: scopes, website: website })
+    end
+
+    def create_authorization_url(client_id, client_secret, scope = 'read', redirect_uri = 'urn:ietf:wg:oauth:2.0:oob')
+      oauth_client = OAuth2::Client.new(client_id, client_secret, site: self.base_url)
+      oauth_client.auth_code.authorize_url(redirect_uri: redirect_uri, scope: scope)
+    end
+
+    def get_access_token(client_id, client_secret, authorization_code, redirect_uri = 'urn:ietf:wg:oauth:2.0:oob')
+      oauth_client = OAuth2::Client.new(client_id, client_secret, site: self.base_url)
+      self.token = oauth_client.auth_code.get_token(authorization_code, redirect_uri: redirect_uri).token
+    end
+  end
+end

data/lib/mstdn_ivory/request.rb

@@ -0,0 +1,22 @@
+require 'http'
+require 'oj'
+require 'mstdn_ivory/dot_accessable_hash'
+
+module MstdnIvory
+  module Request
+    def request(method, path, options)
+      request_url = self.base_url + path
+
+      http_client = HTTP.timeout(:per_operation, connect: self.timeout[:connect], read: self.timeout[:read], write: self.timeout[:write])
+      res = http_client.headers(self.headers).public_send(method, request_url, {form: options})
+      # Change Hash to DotAccessableHash
+      json_data = Oj.load(res)
+      case json_data
+      when Array
+        json_data.map { |elm| MstdnIvory::DotAccessableHash.new.merge(elm) }
+      when Hash
+        MstdnIvory::DotAccessableHash.new.merge(json_data)
+      end
+    end
+  end
+end

data/lib/mstdn_ivory/rest.rb

@@ -0,0 +1,11 @@
+module MstdnIvory
+  module Rest
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+  end
+end

data/lib/mstdn_ivory/version.rb

@@ -0,0 +1,3 @@
+module MstdnIvory
+  VERSION = "0.1.0"
+end

data/lib/mstdn_ivory.rb

@@ -0,0 +1,2 @@
+require 'mstdn_ivory/version'
+require 'mstdn_ivory/client'

data/mstdn_ivory.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mstdn_ivory/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mstdn_ivory"
+  spec.version       = MstdnIvory::VERSION
+  spec.authors       = ["sa2taka"]
+  spec.email         = ["sa2taka@gmail.com"]
+
+  spec.summary       = %q{Ruby interface for Mastodon api.}
+  spec.description   = %q{Ruby interface for Mastodon api, like mastodon-api npm package}
+  spec.homepage      = "https://github.com/sa2taka/mstdn_ivory"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'http', '~> 3.3'
+  spec.add_dependency 'oj', '~> 3.5'
+  spec.add_dependency 'oauth2', '~> 1.4'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: mstdn_ivory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sa2taka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Ruby interface for Mastodon api, like mastodon-api npm package
+email:
+- sa2taka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mstdn_ivory.rb
+- lib/mstdn_ivory/api.rb
+- lib/mstdn_ivory/client.rb
+- lib/mstdn_ivory/dot_accessable_hash.rb
+- lib/mstdn_ivory/register.rb
+- lib/mstdn_ivory/request.rb
+- lib/mstdn_ivory/rest.rb
+- lib/mstdn_ivory/version.rb
+- mstdn_ivory.gemspec
+homepage: https://github.com/sa2taka/mstdn_ivory
+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.2
+signing_key: 
+specification_version: 4
+summary: Ruby interface for Mastodon api.
+test_files: []