mt-data_api-client 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 141d6b47bae13a42e500beef930f5c917c3131c6
-  data.tar.gz: 831b7963bd09646853d89913814e5006ad4175e9
+SHA256:
+  metadata.gz: 11f005aa0a6d381cde026e230bb02af3b5bf3e9861668cccd804e4e9e694732c
+  data.tar.gz: b15ec76d87923c99699b77329d08bc8ef4dde0136ce3c1d18899f68dc2e8771d
 SHA512:
-  metadata.gz: 7e17c5284d00a12494e772f58e2d805dfdb3d6c346f5532863b3282f1c1e3a622b19b87eb0e5a77694c53ecbfde226e0a10d7eac949ca8a2006122d17cd10230
-  data.tar.gz: 297990eba92223fa81b5d7744bae4a3624e9d5756239d536ea5d96860e73ed63c96e11048cf9022fd0c11e7fe121f5acbfad7a2464513aa5eb9c9059464cc230
+  metadata.gz: e5faa4a7416e05baf735938bfc0829175569a0aa0fb787b8aec0a701a47cd520c99968cdf726e7e14984c490cb28582bd2b87bb2b6e9601fffe0116f971f6812
+  data.tar.gz: 433aab34562e93dd30aa873cc47e03c567e271b0020efbb0752f579af348f07f0baeab59e1e9ea00d0f011841ffbfe6e5a78c62484b589f997ae1607d962bc5d

data/README.md

@@ -1,6 +1,6 @@
 # MT::DataAPI::Client
 
-Movable Type Data API client for Ruby. 
+Movable Type Data API client for Ruby.
 
 ## Installation
 
@@ -18,22 +18,67 @@ Or install it yourself as:
 
     $ gem install mt-data_api-client
 
-## Usage
+## Usage samples
 
 ```ruby
 require 'mt/data_api/client'
 
+# Set URL to your mt-data-api.cgi script.
 client = MT::DataAPI::Client.new(
-  base_url: 'http://localhost/mt/mt-data-api.cgi',
-  client_id: 'mt-ruby'
+  base_url: 'http://localhost/mt/mt-data-api.cgi'
 )
 
-# without block
-json = client.call(:list_entries, site_id: 1)
+# Set endpoint ID and its arguments.
+#
+# * You can see the list of endpoints by "client.call(:list_endpoints)"
+# * There is documentation of arguments at https://www.movabletype.jp/developers/data-api/.
+res = client.call(:list_endpoints)
+```
+
+### With block
+
+```ruby
+require 'mt/data_api/client'
+
+client = MT::DataAPI::Client.new(
+  base_url: 'http://localhost/mt/mt-data-api.cgi'
+)
 
-# with block
-client.call(:list_sites) do |res|
-  json = res
+client.call(:list_entries, site_id: 1) do |res|
+  # ...
+end
+```
+
+### Use authentication
+
+```ruby
+require 'mt/data_api/client'
+
+client = MT::DataAPI::Client.new(
+  base_url: 'http://loalhost/mt/mt-data-api.cgi'
+)
+
+res_auth = client.call(:authenticate, username: 'user', password: 'pass')
+
+if res_auth && !res_auth.key?("error")
+  res_list_plugins = client.call(:list_plugins)
+end
+```
+
+### Use upload_asset endpoint
+
+```ruby
+require 'mt/data_api/client'
+
+client = MT::DataAPI::Client.new(
+  base_url: 'http://mt.test:5000/mt-data-api.cgi'
+)
+
+res_auth = client.call(:authenticate, username: 'user', password: 'pass')
+
+if res_auth && !res_auth.key?("error")
+  jpeg_file = File.open('sample.jpg', 'rb')
+  res = client.call(:upload_asset, site_id: 1, file: jpeg_file)
 end
 ```
 
@@ -46,4 +91,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/masiuchi/mt-data_api-client.
-

data/lib/mt/data_api/client.rb

@@ -10,9 +10,12 @@ module MT
       attr_accessor :access_token
 
       def initialize(opts)
-        opts = opts.symbolize_keys
-        @access_token = opts.delete(:access_token)
-        @endpoint_manager = EndpointManager.new(opts)
+        opts_sym = opts.symbolize_keys
+        unless opts_sym.key?(:client_id)
+          opts_sym[:client_id] = default_client_id
+        end
+        @access_token = opts_sym.delete(:access_token)
+        @endpoint_manager = EndpointManager.new(opts_sym)
       end
 
       def call(id, args = {})
@@ -28,6 +31,12 @@ module MT
       def endpoints
         @endpoint_manager.endpoints
       end
+
+      private
+
+      def default_client_id
+        'mt-data_api-client version ' + VERSION
+      end
     end
   end
 end

data/lib/mt/data_api/client/api_request.rb

@@ -30,17 +30,43 @@ module MT
           if access_token
             req['X-MT-Authorization'] = "MTAuth accessToken=#{access_token}"
           end
-          req.set_form_data(args) if post_or_put?
+          set_form(req, args) if post_or_put?
           req
         end
 
+        def contains_file_object?(args)
+          args.values.any? { |v| file?(v) }
+        end
+
+        def file?(file)
+          file.is_a?(File) && File.file?(file.path)
+        end
+
         def http_request_class
           Object.const_get("Net::HTTP::#{@endpoint.verb.capitalize}")
         end
 
+        def multipart_args(args)
+          args.map do |k, v|
+            if file?(v)
+              [k.to_s, v, { filename: File.basename(v.path) }]
+            else
+              [k.to_s, v.to_s]
+            end
+          end
+        end
+
         def post_or_put?
           %w[POST PUT].include? @endpoint.verb
         end
+
+        def set_form(req, args)
+          if contains_file_object?(args)
+            req.set_form(multipart_args(args), 'multipart/form-data')
+          else
+            req.set_form_data(args)
+          end
+        end
       end
     end
   end

data/lib/mt/data_api/client/endpoint.rb

@@ -10,7 +10,7 @@ module MT
       # Send request to endpoint.
       class Endpoint
         class << self
-          attr_writer :api_url
+          attr_writer :api_url, :client_id
         end
 
         attr_reader :verb
@@ -28,7 +28,10 @@ module MT
         end
 
         def call(access_token = nil, args = {})
-          res = APIRequest.new(self).send(access_token, args)
+          res = APIRequest.new(self).send(
+            access_token,
+            client_id_hash.clone.merge(args)
+          )
           return nil if res.body.nil?
           JSON.parse(res.body)
         end
@@ -41,6 +44,18 @@ module MT
 
         private
 
+        def auth_id?
+          %w[authenticate authorize].include?(@id)
+        end
+
+        def client_id_hash
+          if auth_id?
+            { clientId: self.class.instance_variable_get(:@client_id) }
+          else
+            {}
+          end
+        end
+
         def route(args = {})
           route = @route.dup
           route.scan(%r{:[^:/]+(?=/|$)}).each do |m|

data/lib/mt/data_api/client/endpoint_manager.rb

@@ -16,13 +16,13 @@ module MT
         }.freeze
 
         attr_accessor :endpoints
-        attr_reader :access_token
 
         def initialize(opts)
           raise parameter_should_be_hash unless opts.is_a? Hash
           initialize_parameters(opts.symbolize_keys)
           raise invalid_parameter unless @base_url && @client_id
           Endpoint.api_url = api_url
+          Endpoint.client_id = @client_id
         end
 
         def find_endpoint(id)
@@ -37,7 +37,6 @@ module MT
           @client_id = opts[:client_id]
           @api_version = opts[:api_version] || DEFAULT_API_VERSION
           @endpoints = opts[:endpoints] if opts.key? :endpoints
-          @access_token = opts[:access_token] if opts.key? :access_token
         end
 
         def parameter_should_be_hash

data/lib/mt/data_api/client/version.rb

@@ -1,7 +1,7 @@
 module MT
   module DataAPI
     class Client
-      VERSION = '0.0.4'.freeze
+      VERSION = '0.0.5'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mt-data_api-client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Masahiro Iuchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Movable Type Data API client for Ruby.