sony_camera_remote_api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b09ff475a257587236804069142d110d0176e751
-  data.tar.gz: 8bedc578a1e42c47cd9ef6deaf708cad2affaa03
+  metadata.gz: d22147c515ca8ec69ab26b0eaf6c244c04030e5e
+  data.tar.gz: b6f7dd99685957579340411cda11133e29c3ebf6
 SHA512:
-  metadata.gz: 8af7fd14d9a3c3805ee56821f655c21f4bb06b58fc4735d9b69fcdbff2f7cc825c8028e19c238800c3fa29a69321fc8b46a77d2fb48a23be5560727c2e6bccc7
-  data.tar.gz: b80072cf80afade4af08a6dfc49e6496762d8efe3370f54f7ad40ae47ecc5196544322df497a87e81b65bc5b9303b910f2f1566bd622ad8f3ee0abaaad7a2ff0
+  metadata.gz: fc07a67d20bdad6c13d02b6c3bd6fb763882fc40c540ecc734329ee7cf8cd868aa2e871e74347df9800aa3bb54431b75617fccb7181fb11c0cb2d185d9e8e68c
+  data.tar.gz: e1f1e9047a6d92284207f5f73b00ba5a66d58fb8ddfaa4ca1151292b1144076771a24b12f7984f4096e0ed85dcc87f5d404b1e565d145febab206d7849f33970

data/.simplecov

@@ -1,9 +1,9 @@
 if !ENV['COVERAGE'].nil?
   SimpleCov.start do
     add_filter '/spec'
-    # Merge all tests run in 1.5 hours
+    # Merge all tests run in 2 hours
     use_merging true
-    merge_timeout 5400
+    merge_timeout 7200
     command_name "cmd_#{Time.now}"
     puts 'SimpleCov started!!!'
     # minimum_coverage(91.69)

data/README.md

@@ -1,6 +1,6 @@
-# Sony Remote Camera API Wrapper
+# Sony Camera Remote API Wrapper
 
-A Ruby Gem that facilitates the use of Sony Remote Camera API.
+A Ruby Gem that facilitates the use of Sony Camera Remote API.
 
 - [Backgrounds](#backgrounds)
 - [Features](#features)

data/lib/sony_camera_remote_api/camera_api.rb

@@ -212,7 +212,8 @@ module SonyCameraRemoteAPI
       yield
     rescue HTTPClient::TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED => e
       retry_count ||= 0
-      raise e if @reconnect_by.nil? || retry_count >= num
+      retry_count += 1
+      raise e if @reconnect_by.nil? || retry_count > num
       log.error "#{e.class}: #{e.message}"
       log.error 'The camera seems to be disconnected! Reconnecting...'
       unless @reconnect_by.call
@@ -231,7 +232,6 @@ module SonyCameraRemoteAPI
           raise e
         end
       end
-      retry_count += 1
       retry
     end
   end

data/lib/sony_camera_remote_api/client/main.rb

@@ -574,12 +574,12 @@ module SonyCameraRemoteAPI
 
         puts 'Retrieving...'
         if options[:datelist]
-          dates = @cam.get_date_list date_count: options[:count]
-          num_contents = dates.map { |d, c| c }.inject(:+)
+          dates  = @cam.get_date_list date_count: options[:count]
+          num_contents = dates.map { |d| d['contentCount'] }.inject(:+)
           puts "#{dates.size} date folders / #{num_contents} contents found."
           puts "Dates\t\tN-Contents"
-          dates.each do |date, count|
-            puts "#{date['title']}\t#{count}"
+          dates.each do |date|
+            puts "#{date['title']}\t#{date['contentCount']}"
           end
           return
         end

data/lib/sony_camera_remote_api/client/shelf.rb

@@ -160,27 +160,6 @@ module SonyCameraRemoteAPI
       end
 
 
-      desc 'default', 'Show the default camera currently selected'
-      option :json, type: :boolean, desc: 'output in JSON format'
-      def default
-        read_or_create_shelf
-
-        default = @shelf.get
-        unless default
-          puts 'ERROR: Default camera is not selected yet!'
-          return
-        end
-
-        if options[:json]
-          puts JSON.pretty_generate default
-        else
-          puts "SSID      : #{default['ssid']} "
-          puts "Password  : #{default['pass']} "
-          puts "Interface : #{default['interface']} "
-        end
-      end
-
-
       desc 'connect [options]', 'Connect to the default camera'
       option :restart, aliases: '-r', type: :boolean, desc: 'Restart interface', default: false
       option :ssid, aliases: '-s', type: :string, desc: 'Specify camera by SSID'

data/lib/sony_camera_remote_api/version.rb

@@ -1,4 +1,4 @@
 module SonyCameraRemoteAPI
   # Version
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/sony_camera_remote_api.rb

@@ -422,9 +422,24 @@ module SonyCameraRemoteAPI
     #   cam = SonyCameraRemoteAPI::Camera.new
     #   cam.change_function_to_shoot 'still'
     #
-    #   # Try to focus on upper-middle position.
-    #   if cam.act_touch_focus(50, 10)
-    #     cam.capture_still
+    #   th = cam.start_liveview_thread do |img, info|
+    #     focus_frame = info.frames.find { |f| f.category == 1 }
+    #     if focus_frame
+    #       # Get current focus position.
+    #       puts "  top-left     = (#{focus_frame.top_left.x}, #{focus_frame.top_left.y})"
+    #       puts "  bottom-right = (#{focus_frame.bottom_right.x}, #{focus_frame.bottom_right.y})"
+    #     else
+    #       puts 'No focus frame!'
+    #     end
+    #   end
+    #
+    #   # Do touch focus ramdonly, and capture a still if focused.
+    #   loop do
+    #     cam.act_touch_focus rand(101), rand(101)
+    #     if cam.focused?
+    #       cam.capture_still
+    #     end
+    #     sleep 1
     #   end
     def act_touch_focus(x, y)
       return false unless support? :setTouchAFPosition
@@ -456,23 +471,31 @@ module SonyCameraRemoteAPI
     #   cam = SonyCameraRemoteAPI::Camera.new
     #   cam.change_function_to_shoot 'still'
     #
-    #   # Start tracking focus from the center position
-    #   if cam.act_tracking_focus(50, 50)
-    #     th = cam.start_liveview_thread do |img, info|
-    #       info.frames.each do |f|
-    #         # Get tracking focus position from the liveview frame info
-    #         puts "top-left:     (#{f.top_left.x}, #{f.top_left.y})"
-    #         puts "bottom-right: (#{f.bottom_right.x}, #{f.bottom_right.y})"
-    #       end
+    #   th = cam.start_liveview_thread do |img, info|
+    #     tracking_frame = info.frames.find { |f| f.category == 5 }
+    #     if tracking_frame
+    #       # Get tracking focus position from the liveview frame info
+    #       puts "  top-left     = (#{tracking_frame.top_left.x}, #{tracking_frame.top_left.y})"
+    #       puts "  bottom-right = (#{tracking_frame.bottom_right.x}, #{tracking_frame.bottom_right.y})"
+    #     else
+    #       puts 'No tracking frame!'
+    #     end
+    #   end
+    #
+    #   # Capture a still image while tracking.
+    #   loop do
+    #     if cam.tracking?
+    #       cam.capture_still
+    #     else
+    #       cam.act_tracking_focus 50, 50
     #     end
-    #     th.join
+    #     sleep 1
     #   end
     def act_tracking_focus(x, y)
       return false unless support? :TrackingFocus
       cancel_focus
       set_parameter :TrackingFocus, 'On'
 
-
       x = [[x, 100].min, 0].max
       y = [[y, 100].min, 0].max
       actTrackingFocus(['xPosition': x, 'yPosition': y]).result
@@ -690,7 +713,7 @@ module SonyCameraRemoteAPI
       source = getSourceList([{'scheme' => scheme}]).result[0][0]['source']
 
       if date
-        date_found, cnt = get_date_list.find { |d| d[0]['title'] == date }
+        date_found = get_date_list.find { |d| d['title'] == date }
         if date_found
           contents = get_content_list_sub date_found['uri'], type: type, view: 'date', sort: sort, count: count
         else
@@ -702,19 +725,19 @@ module SonyCameraRemoteAPI
         if type.present?
           # if 'type' option is specified, call getContentList with date view for every date.
           # this is because getContentList with flat view is extremely slow as a number of contents grows.
-          dates_counts = get_date_list type: type, sort: sort
+          dates = get_date_list type: type, sort: sort
           contents = []
           if count.present?
-            dates_counts.each do |date, cnt_of_date|
-              num = [cnt_of_date, count - contents.size].min
+            dates.each do |date|
+              num = [date['contentCount'], count - contents.size].min
               contents += get_content_list_sub date['uri'], type: type, view: 'date', sort: sort, count: num
               break if contents.size >= count
             end
             # it is no problem that a number of contents is less than count
             contents = contents[0, count]
           else
-            dates_counts.each do |date, cnt_of_date|
-              contents += get_content_list_sub date['uri'], type: type, view: 'date', sort: sort, count: cnt_of_date
+            dates.each do |date|
+              contents += get_content_list_sub date['uri'], type: type, view: 'date', sort: sort, count: date['contentCount']
             end
           end
         else
@@ -733,22 +756,22 @@ module SonyCameraRemoteAPI
     # @param [String] sort                  Same as 'sort' request parameter of getContentList API
     # @param [Fixnum] date_count            Number of dates to get.
     # @param [Fixnum] content_count         Number of contents to get
-    # @return [Array< Array<String, Fixnum> >]  Array of pairs of a date in format of 'YYYYMMDD' and a number of contents of the date.
+    # @return [Array<Hash>]  An array of dates in format of 'YYYYMMdd' and an array of number of contents of the associated date.
     # @example
     #   # Initialize
     #   cam = SonyCameraRemoteAPI::Camera.new
     #   cam.change_function_to_transfer
     #
-    #   # Get all dates and the number of contents of the date
+    #   # Get all dates and content counts of the associated date.
     #   dates = cam.get_date_list
-    #   # Get 5 newest dates that contains at least one XAVC-S movie content.
+    #   # Get 5 newest dates that contains XAVC-S movie contents.
     #   dates = cam.get_date_list(type: 'movie_xavcs', date_count: 5)
-    #   # Get all dates that contains at least 10 still contents.
-    #   dates = cam.get_date_list(type: 'still', content_count: 10)
+    #   # Get dates until the sum of still contents of each date exceeds 100.
+    #   dates = cam.get_date_list(type: 'still', content_count: 100)
     #
-    #   dates.each do |date, count|
-    #     # Get date and its content count
-    #     puts "#{date['title']}, #{count}"
+    #   dates.each do |date|
+    #     puts "date:  #{date['title']}"            # Get date in the format 'YYYYMMdd'
+    #     puts "count: #{date['contentCount']}"     # Get content count
     #     # Get contents of each date
     #     contents = cam.get_content_list date: date['title']
     #     # Transfer contents
@@ -773,9 +796,12 @@ module SonyCameraRemoteAPI
       dates.each do |d|
         cnt = getContentCount([{'uri' => d['uri'], 'type' => type, 'view' => 'date'}]).result[0]['count']
         # Exclude days of 0 contents.
-        filtered_dates << [d, cnt] if cnt > 0
+        if cnt > 0
+          d['contentCount'] = cnt
+          filtered_dates << d
+        end
         # Break if contents count exceeds.
-        break if content_count and filtered_dates.map { |d, c| c }.inject(0, :+) > content_count
+        break if content_count and filtered_dates.map { |d| d['contentCount'] }.inject(0, :+) > content_count
         # Break if date count exceeds.
         break if date_count and filtered_dates.size > date_count
       end
@@ -784,7 +810,7 @@ module SonyCameraRemoteAPI
 
 
     # Predefined transfer sizes
-    SIZE_LIST = %w(original large small thumbnail).freeze
+    TRANSFER_SIZE_LIST = %w(original large small thumbnail).freeze
     # Transfer content(s) from the camera storage.
     # @note You have to set camera function to 'Contents Transfer' before calling this method.
     # @param [Array<Hash>] contents     Array of content information, which can be obtained by get_content_list
@@ -794,13 +820,15 @@ module SonyCameraRemoteAPI
     # @see get_date_list
     # @todo If 'contents' is directory (date), get all contents of the directory.
     def transfer_contents(contents, filenames=[], dir: nil, size: 'original')
-      if SIZE_LIST.exclude?(size)
-        log.error "#{size} is invalid for size option!"
+      contents = [contents].compact unless contents.is_a? Array
+      filenames = [filenames].compact unless filenames.is_a? Array
+      size = [size].compact unless size.is_a? Array
+      unless size.map { |s| TRANSFER_SIZE_LIST.include? s }.all?
+        log.error "'size' argument contains invalid size name!"
+        log.error "Available sizes are: #{TRANSFER_SIZE_LIST}"
         return nil
       end
 
-      contents = [contents].compact unless contents.is_a? Array
-      filenames = [filenames].compact unless filenames.is_a? Array
       if !filenames.empty?
         if contents.size > filenames.size
           log.warn 'Size of filename list is smaller than that of contents list!'
@@ -810,25 +838,12 @@ module SonyCameraRemoteAPI
         end
       end
 
-      urls_filenames = contents.zip(filenames).map do |content, filename|
-        next unless content
-        url =
-            case size
-              when 'original'
-                raise StandardError if content['content']['original'].size > 1 # FIXME: When do we come here???
-                content['content']['original'][0]['url']
-              when 'large'
-                content['content']['largeUrl']
-              when 'small'
-                content['content']['smallUrl']
-              when 'thumbnail'
-                content['content']['thumbnailUrl']
-            end
-        filename ||= content['content']['original'][0]['fileName']
-        [url, filename]
+      urls_filenames = get_content_url(contents, filenames, size)
+      if urls_filenames.empty?
+        log.warn 'No contents to be transferred.'
+        return []
       end
-
-      log.info "#{contents.size} contents to be transferred."
+      log.info "#{urls_filenames.size} contents to be transferred."
       transferred = transfer_contents_sub(urls_filenames, dir)
       if transferred.size == urls_filenames.size
         log.info 'All transfer completed.'
@@ -1113,6 +1128,47 @@ module SonyCameraRemoteAPI
     end
 
 
+    def get_content_url(contents, filenames, sizes)
+      urls_filenames = []
+      contents.zip(filenames).product(sizes).map { |e| e.flatten }.each do |content, filename, size|
+        next unless content
+
+        filename ||= content['content']['original'][0]['fileName']
+        base = File.basename filename, '.*'
+        case size
+          when 'original'
+            raise StandardError if content['content']['original'].size > 1 # FIXME: When do we come here???
+            url = content['content']['original'][0]['url']
+            ext =
+                case content['contentKind']
+                  when 'still'
+                    '.JPG'
+                  when 'movie_mp4'
+                    '.MP4'
+                  when 'movie_xavcs'
+                    '.MP4'
+                end
+            filename = "#{base}#{ext}"
+          when 'large'
+            url = content['content']['largeUrl']
+            filename = "#{base}_large.JPG"
+          when 'small'
+            url = content['content']['smallUrl']
+            filename = "#{base}_small.JPG"
+          when 'thumbnail'
+            url = content['content']['thumbnailUrl']
+            filename = "#{base}_thumbnail.JPG"
+        end
+        if url.empty?
+          log.error "Skipping empty URL for file: #{filename}, size: #{size}"
+        else
+          urls_filenames << [url, filename]
+        end
+      end
+      urls_filenames
+    end
+
+
     # Try to run given block.
     # If an error raised because of the Wi-Fi disconnection, try to reconnect and run the block again.
     # If error still continues, give it up and raise the error.
@@ -1120,7 +1176,8 @@ module SonyCameraRemoteAPI
       yield
     rescue HTTPClient::BadResponseError, HTTPClient::TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED => e
       retry_count ||= 0
-      raise e if @reconnect_by.nil? || retry_count >= num
+      retry_count += 1
+      raise e if @reconnect_by.nil? || retry_count > num
       log.error "#{e.class}: #{e.message}"
       log.error 'The camera seems to be disconnected! Reconnecting...'
       unless @reconnect_by.call
@@ -1138,7 +1195,6 @@ module SonyCameraRemoteAPI
           raise e
         end
       end
-      retry_count += 1
       retry if retrying
     end
 

data/sony_camera_remote_api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["kota65535"]
   spec.email         = ["kota65535@gmail.com"]
 
-  spec.summary       = %q{A Ruby Gem that facilitates the use of Sony Remote Camera API.}
+  spec.summary       = %q{A Ruby Gem that facilitates the use of Sony Camera Remote API.}
   # spec.description   = %q{A Ruby Gem that facilitates the use of Sony Remote Camera API.}
   spec.homepage      = "https://github.com/kota65535/sony_camera_remote_api"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sony_camera_remote_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - kota65535
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -227,5 +227,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby Gem that facilitates the use of Sony Remote Camera API.
+summary: A Ruby Gem that facilitates the use of Sony Camera Remote API.
 test_files: []