docbase 1.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 728edfa970bd8285f61e71a09a44e88bb46ff8e0170aa37dd8e65ab1ec248966
-  data.tar.gz: ff31c545d7cce734042655cf65e965276d024805724e6c2ef75f8f50bf5242cc
+  metadata.gz: b6c70d4491502f49f4510006bcc8f630d7b207c2e33b4d40dc11cbd4749b0ae4
+  data.tar.gz: 206860601acdc3d22e1a315c0ddce113f6b6776a309570cbe4804e7f878a0cf4
 SHA512:
-  metadata.gz: 57b754ce6b4f12b36e3c2eba089752337fb8f78bd86ddefef83373566291cf306950ef4416fad27114a67ea24c618aa32044e88c3429f1a9efbebae0979498d4
-  data.tar.gz: 0bb4c1d0803beb8b3758e4992c0e88d05cb2be0a7d591643bc73da74e096b4392de0e4eba0a1991b58d9e7ebff2a381e3610646b63491086487f847cad5f2e4c
+  metadata.gz: dbe5ff0494d2605b6aacea6a1b95b417ca710e302233bce291da160cd6b311785e684a4d5492f5c2824500d9a6b0d67f1966cc1d5733dedb8283c5d88f9bf8a9
+  data.tar.gz: a9b8d6813eb18db3599a1ad4019f9d45f29441caea3c0e5d47ee33734e7eacd8b1837e9cdffbee281c6cc726dd08e8e006d81d61c972e83607296db395ea2468

data/.travis.yml

@@ -1,10 +1,6 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
   - 2.6
+  - 2.7
+  - 3.0
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 2.1.1
+
+* グループ取得APIにグループ名/ページネーションが渡せてるように fix: #17
+
+## 2.1.0
+
+* faradayを1.0.0以上でも使えるように
+* ruby 2.4をサポート対象外に
+
+## 2.0.1
+
+* ファイルダウンロードAPIに対応
+
+## 2.0.0
+
+* DocBaseAPIv2用としてリリース
+* チーム一覧APIを廃止
+* 環境変数`DOCBASE_ACCESS_TOKEN`でのトークン読み込みを廃止
+
 ## 1.0.0
 
 * DocBaseAPIv1用としてリリース

data/Gemfile

@@ -4,6 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rake', '~> 10.4'
-  gem 'rspec', '~> 3.8.0'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.10'
 end

data/README.md

@@ -26,21 +26,6 @@ Or install it yourself as:
 client = DocBase::Client.new(access_token: 'your_access_token', team: 'your_team')
 ```
 
-or
-
-```ruby
-ENV['DOCBASE_ACCESS_TOKEN'] = 'your_access_token'
-
-client = DocBase::Client.new(team: 'your_team')
-```
-
-### teams
-
-```ruby
-client.teams.body
-# => [{ domain: 'kray', name: 'kray' }, { domain: 'danny', name: 'danny' }]
-```
-
 ### users
 
 ```ruby
@@ -63,6 +48,8 @@ client.tags.body
 
 ```ruby
 client.groups.body
+client.groups(name: 'developers').body
+client.groups(page: 2, per_page: 10).body
 ```
 
 #### Show
@@ -200,6 +187,13 @@ client.upload('./test.jpg')
 client.upload(['./test.jpg', './README.md'])
 ```
 
+#### Download
+
+```ruby
+response = client.attachment(file_id)
+File.open(file_id, 'wb') { |f| f.write(response.body) }
+```
+
 ### switch team
 
 ```ruby
@@ -208,6 +202,7 @@ client.tags.body
 # => [{ name: 'ruby' }, { name: 'rails' }]
 
 client.team = 'danny'
+client.access_token = 'danny_team_access_token'
 client.tags.body
 # => [{ name: 'javascript' }, { name: 'react' }]
 ```

data/docbase.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 0.15.2'
-  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+  spec.add_dependency 'faraday', '>= 0.15.2'
+  spec.add_dependency 'faraday_middleware', '>= 0.12.2'
 end

data/lib/docbase/client.rb

@@ -6,10 +6,10 @@ module DocBase
     class NotSetTeamError < StandardError; end
     class NotSetPostIdError < StandardError; end
 
-    attr_accessor :team
+    attr_accessor :team, :access_token
 
     def initialize(access_token: nil, url: nil, team: nil)
-      @access_token = access_token || ENV['DOCBASE_ACCESS_TOKEN']
+      self.access_token = access_token
       self.team = team
       @url = url || DEFAULT_URL
     end
@@ -19,10 +19,6 @@ module DocBase
       @team
     end
 
-    def teams
-      connection.get('/teams')
-    end
-
     def users(q: nil, page: 1, per_page: 100, include_user_groups: false)
       connection.get("/teams/#{team!}/users", q: q, page: page, per_page: per_page, include_user_groups: include_user_groups)
     end
@@ -31,8 +27,8 @@ module DocBase
       connection.get("/teams/#{team!}/tags")
     end
 
-    def groups
-      connection.get("/teams/#{team!}/groups")
+    def groups(name: nil, page: 1, per_page: 100)
+      connection.get("/teams/#{team!}/groups", name: name, page: page, per_page: per_page)
     end
 
     def group(id)
@@ -117,6 +113,10 @@ module DocBase
       connection.post("/teams/#{team!}/attachments", params)
     end
 
+    def attachment(id)
+      connection_for_binary.get("/teams/#{team!}/attachments/#{id}")
+    end
+
     private
 
     def except(hash, reject_key)
@@ -131,12 +131,19 @@ module DocBase
       end
     end
 
+    def connection_for_binary
+      @connection ||= Faraday.new({ url: @url, headers: headers }) do |faraday|
+        faraday.request :json
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
     def headers
       {
         'Accept'         => 'application/json',
         'User-Agent'     => USER_AGENT,
-        'X-DocBaseToken' => @access_token,
-        'X-Api-Version'  => 1,
+        'X-DocBaseToken' => access_token,
+        'X-Api-Version'  => '2',
       }
     end
   end

data/lib/docbase/version.rb

@@ -1,3 +1,3 @@
 module DocBase
-  VERSION = '1.0.0'
+  VERSION = '2.1.1'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: docbase
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - ttakuru88
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.2
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.2
 description: DocBase API Client, written in Ruby
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: DocBase API Client, written in Ruby