Merge pull request #2 from gibahjoe/feature/always-run

Feature/always run

Author: gibahjoe

CHANGELOG.md

@@ -1,3 +1,3 @@
 ## 1.0.0
 
-- Initial version, created by Stagehand
+- Initial version

LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Joseph Gibah
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
+conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived
+from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

example/.gitignore

@@ -188,3 +188,5 @@ fabric.properties
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
+!/api/petstore_api/pubspec.yaml
+api/

example/api/petstore_api/pubspec.yaml

@@ -0,0 +1,12 @@
+name: petstore_api
+version: 1.0.0
+description: OpenAPI API client
+environment:
+    sdk: ">=2.0.0 <3.0.0"
+dependencies:
+    jaguar_retrofit: ^2.8.8
+    jaguar_serializer: ^2.2.12
+dev_dependencies:
+    jaguar_retrofit_gen: ^2.8.10
+    jaguar_serializer_cli: ^2.2.8
+    build_runner: ^1.6.5

example/lib/main.dart

@@ -1,5 +1,6 @@
 import 'package:flutter/material.dart';
-
+import 'package:petstore_api/api.dart';
+import 'package:petstore_api/api/store_api.dart';
 
 void main() => runApp(MyApp());
 
@@ -23,7 +24,6 @@ class MyApp extends StatelessWidget {
       ),
       home: MyHomePage(title: 'Flutter Demo Home Page'),
     );
-
   }
 }
 
@@ -48,6 +48,14 @@ class MyHomePage extends StatefulWidget {
 class _MyHomePageState extends State<MyHomePage> {
   int _counter = 0;
 
+  StoreApi _petApi = PetstoreApi().getStoreApi();
+
+  @override
+  void initState() {
+    // TODO: implement initState
+    super.initState();
+  }
+
   void _incrementCounter() {
     setState(() {
       // This call to setState tells the Flutter framework that something has
@@ -73,35 +81,32 @@ class _MyHomePageState extends State<MyHomePage> {
         // the App.build method, and use it to set our appbar title.
         title: Text(widget.title),
       ),
-      body: Center(
-        // Center is a layout widget. It takes a single child and positions it
-        // in the middle of the parent.
-        child: Column(
-          // Column is also a layout widget. It takes a list of children and
-          // arranges them vertically. By default, it sizes itself to fit its
-          // children horizontally, and tries to be as tall as its parent.
-          //
-          // Invoke "debug painting" (press "p" in the console, choose the
-          // "Toggle Debug Paint" action from the Flutter Inspector in Android
-          // Studio, or the "Toggle Debug Paint" command in Visual Studio Code)
-          // to see the wireframe for each widget.
-          //
-          // Column has various properties to control how it sizes itself and
-          // how it positions its children. Here we use mainAxisAlignment to
-          // center the children vertically; the main axis here is the vertical
-          // axis because Columns are vertical (the cross axis would be
-          // horizontal).
-          mainAxisAlignment: MainAxisAlignment.center,
-          children: <Widget>[
-            Text(
-              'You have pushed the button this many times:',
-            ),
-            Text(
-              '$_counter',
-              style: Theme.of(context).textTheme.display1,
-            ),
-          ],
-        ),
+      body: FutureBuilder<Map<String, int>>(
+        builder: (context, snapshot) {
+          if(snapshot.hasError){
+            Center(
+              child: Text(snapshot.error.toString()),
+            );
+          }
+          if (!snapshot.hasData) {
+            return Center(
+              child: CircularProgressIndicator(),
+            );
+          }
+          if (snapshot.hasData && snapshot.data.isEmpty) {
+            return Center(
+              child: Text('NO DATA'),
+            );
+          }
+          var entries = snapshot.data.entries.toList();
+          return ListView.separated(
+              itemBuilder: (context, index) {
+                return Text('${entries[0].key} : ${entries[index].value}');
+              },
+              separatorBuilder: (context, index) => Divider(),
+              itemCount: snapshot.data.values.length);
+        },
+        future: _petApi.getInventory(),
       ),
       floatingActionButton: FloatingActionButton(
         onPressed: _incrementCounter,

example/lib/openapi_config.dart

@@ -0,0 +1,10 @@
+import 'package:openapi_generator_annotations/openapi_generator_annotations.dart';
+
+@Openapi(
+    additionalProperties:
+    AdditionalProperties(pubName: 'petstore_api', pubAuthor: 'Johnny depp'),
+    inputSpecFile: 'spec/openapi-spec.yaml',
+    generatorName: 'dart-jaguar',
+    outputDirectory: 'api/petstore_api')
+class OpenapiConfig extends OpenapiGeneratorConfig {
+}

example/pubspec.yaml

@@ -19,8 +19,10 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  openapi_generator_annotations:
-    path: ../openapi-generator-annotations
+  openapi_generator_annotations: ^1.0.2
+  petstore_api:
+    path: api/petstore_api
+  provider: ^4.0.4
 
 
   # The following adds the Cupertino Icons font to your application.
@@ -31,8 +33,7 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
   build_runner: ^1.7.4
-  openapi_generator:
-    path: ../openapi-generator
+  openapi_generator: ^0.1.2
 
 
 # For information on the generic Dart part of this file, see the

openapi-generator-annotations/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.2
+
+- Updated documentation
+
 ## 0.0.2-dev
 
 - Changed version to dev since this package is still in active development

openapi-generator-annotations/README.md

@@ -1,11 +1,27 @@
 Annotation library for dart/flutter implementation of openapi client code generation.
+To be used together with [openapi-generator](https://pub.dev/packages/openapi_generator)
 
-Created from templates made available by Stagehand under a BSD-style
-[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE).
+[license](https://github.com/gibahjoe/openapi-generator-dart/blob/master/openapi-generator-annotations/LICENSE).
 
 ## Usage
 
-A simple usage example:
+Include [openapi-generator-annotations](https://pub.dev/packages/openapi_generator_annotations) as a dependency in the dependencies section of your pubspec.yaml file :
+
+```yaml
+dependencies:
+  openapi_generator_annotations: ^1.0.0
+```
+
+
+Add [openapi-generator](https://pub.dev/packages/openapi_generator) in the dev dependencies section of your pubspec.yaml file:
+
+```yaml
+dev_dependencies:
+  openapi_generator: ^0.0.2-beta
+```
+
+
+Annotate a dart class with @Openapi() annotation
 
 ```dart
 @Openapi(
@@ -17,6 +33,13 @@ A simple usage example:
 class Example extends OpenapiGeneratorConfig {}
 ```
 
+Run command below to generate open api client sdk from spec file specified in annotation. 
+```cmd
+flutter pub run build_runner build --delete-conflicting-outputs
+```
+
+The api sdk will be generated in the folder specified in the annotation. See examples for more details
+
 ## Features and bugs
 
 Please file feature requests and bugs at the [issue tracker][tracker].

openapi-generator-annotations/lib/src/openapi_generator_annotations_base.dart

@@ -4,26 +4,32 @@ abstract class OpenapiGeneratorConfig {}
 
 class Openapi {
   /// Additional properties to pass to tge compiler (CSV)
+  ///
   /// --additional-properties
   final AdditionalProperties additionalProperties;
 
   /// relative path or url to spec file
+  ///
   /// -i
   final String inputSpecFile;
 
-  /// Generator to use (see list command for list)
+  /// Generator to use (dart|dart-jaguar|dart-dio)
+  ///
   /// -g, --generator-name
   final String generatorName;
 
   ///  Where to write the generated files (current dir by default)
+  ///
   ///  -o, --output
   final String outputDirectory;
 
   ///  Specifies if the existing files should be overwritten during the generation
+  ///
   ///  -s, --skip-overwrite
   final bool overwriteExistingFiles;
 
   /// Skips the default behavior of validating an input specification.
+  ///
   /// --skip-validate-spec
   final bool skipValidateSpec;
 
@@ -91,8 +97,4 @@ class AdditionalProperties {
       this.sortModelPropertiesByRequiredFlag = true,
       this.sortParamsByRequiredFlag = true,
       this.sourceFolder});
-
-  String _append(String base, String str) {
-    return '$base,$str';
-  }
 }