sentiment_insights 0.3.0 → 0.4.0

data/lib/sentiment_insights/export/json_exporter.rb

@@ -0,0 +1,183 @@
+require_relative 'base_exporter'
+require 'json'
+
+module SentimentInsights
+  module Export
+    class JsonExporter < BaseExporter
+      def export(filename = nil)
+        filename ||= generate_filename("json")
+        
+        # Apply filters if specified
+        filtered_result = apply_filters(@result)
+        
+        structured_data = build_json_structure(filtered_result)
+        
+        if filename
+          File.write(filename, JSON.pretty_generate(structured_data))
+          filename
+        else
+          structured_data  # Return data directly for API responses
+        end
+      end
+
+      # Return JSON string without writing to file
+      def to_json_string
+        structured_data = build_json_structure(apply_filters(@result))
+        JSON.pretty_generate(structured_data)
+      end
+
+      # Return raw hash structure (for API responses)
+      def to_hash
+        build_json_structure(apply_filters(@result))
+      end
+
+      private
+
+      def build_json_structure(data)
+        {
+          metadata: build_metadata,
+          analysis: build_analysis_data(data),
+          export_info: build_export_info
+        }
+      end
+
+      def build_metadata
+        {
+          export_timestamp: Time.now.utc.iso8601,
+          analysis_type: analysis_type.to_s,
+          total_responses: extract_responses_data.count,
+          provider_used: detect_provider
+        }
+      end
+
+      def build_analysis_data(data)
+        case analysis_type
+        when :sentiment
+          build_sentiment_json(data)
+        when :entities
+          build_entities_json(data)
+        when :key_phrases
+          build_phrases_json(data)
+        else
+          data
+        end
+      end
+
+      def build_sentiment_json(data)
+        result = {
+          responses: format_responses_for_json(data[:responses] || [])
+        }
+        
+        if options[:include_summary] && data[:global_summary]
+          result[:global_summary] = data[:global_summary]
+        end
+        
+        if options[:include_segments] && data[:segment_summary]
+          result[:segment_summary] = format_segment_summary_for_json(data[:segment_summary])
+        end
+        
+        if data[:top_positive_comments]
+          result[:top_positive_comments] = data[:top_positive_comments]
+        end
+        
+        if data[:top_negative_comments]
+          result[:top_negative_comments] = data[:top_negative_comments]
+        end
+        
+        result
+      end
+
+      def build_entities_json(data)
+        {
+          entities: format_entities_for_json(data[:entities] || []),
+          responses: format_responses_for_json(data[:responses] || [])
+        }
+      end
+
+      def build_phrases_json(data)
+        {
+          phrases: format_phrases_for_json(data[:phrases] || []),
+          responses: format_responses_for_json(data[:responses] || [])
+        }
+      end
+
+      def format_responses_for_json(responses)
+        responses.map do |response|
+          formatted = {
+            id: response[:id] || "r_#{responses.index(response) + 1}",
+            text: response[:sentence] || response[:answer],
+            segment: response[:segment] || {}
+          }
+          
+          # Add analysis-specific fields
+          case analysis_type
+          when :sentiment
+            formatted[:sentiment] = {
+              label: response[:sentiment_label] || response[:sentiment],
+              score: response[:sentiment_score] || 0.0
+            }
+          when :key_phrases
+            formatted[:sentiment] = {
+              label: response[:sentiment],
+              score: response[:sentiment_score] || 0.0
+            }
+          end
+          
+          formatted[:timestamp] = format_timestamp if options[:include_timestamp]
+          formatted
+        end
+      end
+
+      def format_entities_for_json(entities)
+        entities.map do |entity|
+          {
+            entity: entity[:entity],
+            type: entity[:type],
+            mentions: entity[:mentions] || [],
+            summary: entity[:summary] || {}
+          }
+        end
+      end
+
+      def format_phrases_for_json(phrases)
+        phrases.map do |phrase|
+          {
+            phrase: phrase[:phrase],
+            mentions: phrase[:mentions] || [],
+            summary: phrase[:summary] || {}
+          }
+        end
+      end
+
+      def format_segment_summary_for_json(segment_summary)
+        formatted = {}
+        segment_summary.each do |segment_type, segments|
+          next if [:top_positive_comments, :top_negative_comments].include?(segment_type)
+          
+          formatted[segment_type] = {}
+          segments.each do |segment_value, stats|
+            formatted[segment_type][segment_value] = stats
+          end
+        end
+        formatted
+      end
+
+      def build_export_info
+        {
+          format: "json",
+          options_used: @options,
+          filters_applied: @options[:filter] || {},
+          generated_at: Time.now.utc.iso8601
+        }
+      end
+
+      def detect_provider
+        # Try to detect which provider was used based on result structure
+        return "unknown" unless @result.is_a?(Hash)
+        
+        # This could be enhanced based on provider-specific signatures
+        "auto-detected"
+      end
+    end
+  end
+end

data/lib/sentiment_insights/insights/entities.rb

@@ -1,3 +1,5 @@
+require_relative '../export/exportable'
+
 module SentimentInsights
   module Insights
     # Extracts and summarizes named entities from survey responses
@@ -58,10 +60,10 @@ module SentimentInsights
           }
         end
 
-        {
+        SentimentInsights::Export::Result.wrap({
           entities: enriched_entities,
           responses: responses
-        }
+        })
       end
     end
   end

data/lib/sentiment_insights/insights/key_phrases.rb

@@ -1,6 +1,7 @@
 require_relative '../clients/key_phrases/open_ai_client'
 require_relative '../clients/key_phrases/claude_client'
 require_relative '../clients/key_phrases/aws_client'
+require_relative '../export/exportable'
 
 module SentimentInsights
   module Insights
@@ -73,10 +74,10 @@ module SentimentInsights
           }
         end
 
-        {
+        SentimentInsights::Export::Result.wrap({
           phrases: enriched_phrases,
           responses: responses
-        }
+        })
       end
     end
   end

data/lib/sentiment_insights/insights/sentiment.rb

@@ -2,6 +2,7 @@ require_relative '../clients/sentiment/open_ai_client'
 require_relative '../clients/sentiment/claude_client'
 require_relative '../clients/sentiment/sentimental_client'
 require_relative '../clients/sentiment/aws_comprehend_client'
+require_relative '../export/exportable'
 
 module SentimentInsights
   module Insights
@@ -52,14 +53,14 @@ module SentimentInsights
 
         top_positive_comments, top_negative_comments = top_comments(annotated_responses)
 
-        # Assemble the result hash
-        {
+        # Assemble the result hash and wrap with export functionality
+        SentimentInsights::Export::Result.wrap({
           global_summary:       global_summary,
           segment_summary:      segment_summary,
           top_positive_comments: top_positive_comments,
           top_negative_comments: top_negative_comments,
           responses:            annotated_responses
-        }
+        })
       end
 
       private

data/lib/sentiment_insights/version.rb

@@ -1,3 +1,3 @@
 module SentimentInsights
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/sentiment_insights.rb

@@ -1,6 +1,7 @@
 require "sentiment_insights/configuration"
 require "sentiment_insights/analyzer"
 require "sentiment_insights/insights/sentiment"
+require "sentiment_insights/export/exportable"
 
 module SentimentInsights
   class Error < StandardError; end

data/sentiment_insights.gemspec

@@ -31,6 +31,9 @@ Gem::Specification.new do |spec|
   # Runtime dependencies
   spec.add_dependency "sentimental", "~> 1.4.0"
   spec.add_dependency "aws-sdk-comprehend", ">= 1.98.0"
+  
+  # Export dependencies
+  spec.add_dependency "rubyXL", "~> 3.4"  # Excel export support
 
   # Development dependencies
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentiment_insights
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - mathrailsAI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-25 00:00:00.000000000 Z
+date: 2025-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentimental
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.98.0
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md
+- EXPORT_USAGE.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -127,6 +142,12 @@ files:
 - lib/sentiment_insights/clients/sentiment/open_ai_client.rb
 - lib/sentiment_insights/clients/sentiment/sentimental_client.rb
 - lib/sentiment_insights/configuration.rb
+- lib/sentiment_insights/export/base_exporter.rb
+- lib/sentiment_insights/export/csv_exporter.rb
+- lib/sentiment_insights/export/excel_exporter.rb
+- lib/sentiment_insights/export/exportable.rb
+- lib/sentiment_insights/export/exporter.rb
+- lib/sentiment_insights/export/json_exporter.rb
 - lib/sentiment_insights/insights/entities.rb
 - lib/sentiment_insights/insights/key_phrases.rb
 - lib/sentiment_insights/insights/sentiment.rb